[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/jinx a70bc099ed 2/2: Improve jinx-correct docstring
From: |
ELPA Syncer |
Subject: |
[elpa] externals/jinx a70bc099ed 2/2: Improve jinx-correct docstring |
Date: |
Tue, 12 Sep 2023 06:58:08 -0400 (EDT) |
branch: externals/jinx
commit a70bc099ed7aed9f5e80c0462f64ef2812b28947
Author: Daniel Mendler <mail@daniel-mendler.de>
Commit: Daniel Mendler <mail@daniel-mendler.de>
Improve jinx-correct docstring
---
jinx.el | 10 +++++++---
1 file changed, 7 insertions(+), 3 deletions(-)
diff --git a/jinx.el b/jinx.el
index ccb8d7d2e9..4ecff04224 100644
--- a/jinx.el
+++ b/jinx.el
@@ -910,9 +910,13 @@ Suggest corrections even if the word is not misspelled."
;;;###autoload
(defun jinx-correct (&optional arg)
"Correct word depending on prefix ARG.
-- If prefix ARG is nil, correct nearest misspelled word.
-- If prefix ARG is 4 (C-u pressed once), correct all misspelled words.
-- If prefix ARG is 16 (C-u pressed twice), correct word before point."
+This command dispatches to the following commands:
+ - `jinx-correct-nearest': If prefix ARG is nil, correct nearest
+ misspelled word.
+ - `jinx-correct-all': If prefix ARG is 4, corresponding to C-u
+ pressed once, correct all misspelled words.
+ - `jinx-correct-word': If prefix ARG is 16, corresponding to
+ C-u pressed twice, correct word before point."
(interactive "*P")
(pcase arg
('nil (jinx-correct-nearest))