]> git.eshelyaron.com Git - emacs.git/commitdiff
Improve documentation of Flyspell
authorEli Zaretskii <eliz@gnu.org>
Thu, 12 Jul 2018 15:59:18 +0000 (18:59 +0300)
committerEli Zaretskii <eliz@gnu.org>
Thu, 12 Jul 2018 15:59:18 +0000 (18:59 +0300)
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.

doc/emacs/fixit.texi
lisp/textmodes/flyspell.el

index fe2da7ae4f132b1f0d24965ff3ecc52d5f4fbe08..7bbaa0016badca071b4328d6820d74a41e22ada8 100644 (file)
@@ -408,11 +408,15 @@ dictionary.
 @cindex mode, Flyspell
 @findex flyspell-mode
   Flyspell mode is a minor mode that performs automatic spell-checking
-as you type.  When it finds a word that it does not recognize, it
-highlights that word.  Type @kbd{M-x flyspell-mode} to toggle Flyspell
-mode in the current buffer.  To enable Flyspell mode in all text mode
-buffers, add @code{flyspell-mode} to @code{text-mode-hook}.
-@xref{Hooks}.
+of the text you type as you type it.  When it finds a word that it
+does not recognize, it highlights that word.  Type @kbd{M-x
+flyspell-mode} to toggle Flyspell mode in the current buffer.  To
+enable Flyspell mode in all text mode buffers, add
+@code{flyspell-mode} to @code{text-mode-hook}.  @xref{Hooks}.  Note
+that, as Flyspell mode needs to check each word across which you move,
+it will slow down cursor motion and scrolling commands.  It also
+doesn't automatically check the text you didn't type or move across;
+use @code{flyspell-region} or @code{flyspell-buffer} for that.
 
 @findex flyspell-correct-word
 @findex flyspell-auto-correct-word
index 24e424c663c2837ee1e59f6e6f5f5d006967957b..3bad41ab7a40a5954541da6e9d7bfbafd57849df 100644 (file)
 ;;
 ;; To enable Flyspell in text representing computer programs, type
 ;; M-x flyspell-prog-mode.
-;; In that mode only text inside comments is checked.
+;; In that mode only text inside comments and strings is checked.
 ;;
 ;; Some user variables control the behavior of flyspell.  They are
-;; those defined under the `User variables' comment.
+;; those defined under the `User configuration' comment.
 
 ;;; Code: