diff options
| author | Eli Zaretskii | 2018-07-12 18:59:18 +0300 |
|---|---|---|
| committer | Eli Zaretskii | 2018-07-12 18:59:18 +0300 |
| commit | 9b49a8ed4a39c5d24336bda2ee0ee070ebe08221 (patch) | |
| tree | 521afdc9d719d443ebeacb9a775535c80e6640e3 | |
| parent | 3744fda5fa92ed058a1eb636a7836759ae5ab06f (diff) | |
| download | emacs-9b49a8ed4a39c5d24336bda2ee0ee070ebe08221.tar.gz emacs-9b49a8ed4a39c5d24336bda2ee0ee070ebe08221.zip | |
Improve documentation of Flyspell
For the background, see
http://lists.gnu.org/archive/html/help-gnu-emacs/2018-07/msg00099.html.
* doc/emacs/fixit.texi (Spelling): Add a couple of caveats.
* lisp/textmodes/flyspell.el: Update commentary.
| -rw-r--r-- | doc/emacs/fixit.texi | 14 | ||||
| -rw-r--r-- | lisp/textmodes/flyspell.el | 4 |
2 files changed, 11 insertions, 7 deletions
diff --git a/doc/emacs/fixit.texi b/doc/emacs/fixit.texi index fe2da7ae4f1..7bbaa0016ba 100644 --- a/doc/emacs/fixit.texi +++ b/doc/emacs/fixit.texi | |||
| @@ -408,11 +408,15 @@ dictionary. | |||
| 408 | @cindex mode, Flyspell | 408 | @cindex mode, Flyspell |
| 409 | @findex flyspell-mode | 409 | @findex flyspell-mode |
| 410 | Flyspell mode is a minor mode that performs automatic spell-checking | 410 | Flyspell mode is a minor mode that performs automatic spell-checking |
| 411 | as you type. When it finds a word that it does not recognize, it | 411 | of the text you type as you type it. When it finds a word that it |
| 412 | highlights that word. Type @kbd{M-x flyspell-mode} to toggle Flyspell | 412 | does not recognize, it highlights that word. Type @kbd{M-x |
| 413 | mode in the current buffer. To enable Flyspell mode in all text mode | 413 | flyspell-mode} to toggle Flyspell mode in the current buffer. To |
| 414 | buffers, add @code{flyspell-mode} to @code{text-mode-hook}. | 414 | enable Flyspell mode in all text mode buffers, add |
| 415 | @xref{Hooks}. | 415 | @code{flyspell-mode} to @code{text-mode-hook}. @xref{Hooks}. Note |
| 416 | that, as Flyspell mode needs to check each word across which you move, | ||
| 417 | it will slow down cursor motion and scrolling commands. It also | ||
| 418 | doesn't automatically check the text you didn't type or move across; | ||
| 419 | use @code{flyspell-region} or @code{flyspell-buffer} for that. | ||
| 416 | 420 | ||
| 417 | @findex flyspell-correct-word | 421 | @findex flyspell-correct-word |
| 418 | @findex flyspell-auto-correct-word | 422 | @findex flyspell-auto-correct-word |
diff --git a/lisp/textmodes/flyspell.el b/lisp/textmodes/flyspell.el index 24e424c663c..3bad41ab7a4 100644 --- a/lisp/textmodes/flyspell.el +++ b/lisp/textmodes/flyspell.el | |||
| @@ -31,10 +31,10 @@ | |||
| 31 | ;; | 31 | ;; |
| 32 | ;; To enable Flyspell in text representing computer programs, type | 32 | ;; To enable Flyspell in text representing computer programs, type |
| 33 | ;; M-x flyspell-prog-mode. | 33 | ;; M-x flyspell-prog-mode. |
| 34 | ;; In that mode only text inside comments is checked. | 34 | ;; In that mode only text inside comments and strings is checked. |
| 35 | ;; | 35 | ;; |
| 36 | ;; Some user variables control the behavior of flyspell. They are | 36 | ;; Some user variables control the behavior of flyspell. They are |
| 37 | ;; those defined under the `User variables' comment. | 37 | ;; those defined under the `User configuration' comment. |
| 38 | 38 | ||
| 39 | ;;; Code: | 39 | ;;; Code: |
| 40 | 40 | ||