procyberian/emacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Fix documentation of 'flyspell-auto-correct-word'

Browse source 
* lisp/textmodes/flyspell.el (flyspell-get-word): Elaborate in the
doc string on how the function looks for the word to spell-check.
(flyspell-word, flyspell-auto-correct-word): Refer to
'flyspell-get-word' for details about finding the word.
(Bug#30462)
This commit is contained in:
Eli Zaretskii 2018-02-20 06:22:57 +02:00
parent a8c843478c
commit 226aca32a7
1 changed files with 15 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

19
lisp/textmodes/flyspell.el
View file

@ -1103,7 +1103,10 @@ If the optional argument FOLLOWING, or, when called interactively
`ispell-following-word', is non-nil, checks the following (rather
than preceding) word when the cursor is not over a word. If
optional argument KNOWN-MISSPELLING is non nil considers word a
misspelling and skips redundant spell-checking step."
misspelling and skips redundant spell-checking step.
See `flyspell-get-word' for details of how this finds the word to
spell-check."
(interactive (list ispell-following-word))
(ispell-set-spellchecker-params) ; Initialize variables and dicts alists
(save-excursion
@ -1302,7 +1305,13 @@ misspelling and skips redundant spell-checking step."
Optional argument FOLLOWING non-nil means to get the following
\(rather than preceding) word when the cursor is not over a word.
Optional second argument EXTRA-OTHERCHARS is a regexp of characters
that may be included as part of a word (see `ispell-dictionary-alist')."
that may be included as part of a word (see `ispell-dictionary-alist').
This finds the word to spell-check by searching for CASECHARS defined
in `ispell-dictionary-alist' for the current dictionary. Thus, the
word could be far away of point if point is inside whitespace or
punctuation characters, or in text that belongs to a different
language."
(let* ((flyspell-casechars (flyspell-get-casechars))
(flyspell-not-casechars (flyspell-get-not-casechars))
(ispell-otherchars (ispell-get-otherchars))
@ -1919,8 +1928,10 @@ before point that's highlighted as misspelled."
"Correct the current word.
This command proposes various successive corrections for the
current word. If invoked repeatedly on the same position, it
cycles through the possible corrections of the word at or near
that position."
cycles through the possible corrections of the current word.
See `flyspell-get-word' for details of how this finds the word to
spell-check."
(interactive)
;; If we are not in the construct where flyspell should be active,
;; invoke the original binding of M-TAB, if that was recorded.