[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/jit-spell e023f0b99d 1/3: Update README and commentary
From: |
ELPA Syncer |
Subject: |
[elpa] externals/jit-spell e023f0b99d 1/3: Update README and commentary |
Date: |
Sat, 11 Mar 2023 04:58:31 -0500 (EST) |
branch: externals/jit-spell
commit e023f0b99d3cadbb4df936eb3678a26eb9e8526c
Author: Augusto Stoffel <arstoffel@gmail.com>
Commit: Augusto Stoffel <arstoffel@gmail.com>
Update README and commentary
---
README.org | 26 ++++++++++++--------------
jit-spell.el | 4 ++--
2 files changed, 14 insertions(+), 16 deletions(-)
diff --git a/README.org b/README.org
index 722ec6db1b..7f371c2e43 100644
--- a/README.org
+++ b/README.org
@@ -1,7 +1,6 @@
#+title: jit-spell --- Just-in-time spell checking
#+html: <p align="center"><a
href="http://elpa.gnu.org/packages/jit-spell.html"><img alt="GNU ELPA"
src="https://elpa.gnu.org/packages/jit-spell.svg"/></a></p>
-#+html: <p align="center"><a
href="http://elpa.gnu.org/devel/jit-spell.html"><img alt="GNU ELPA"
src="https://elpa.gnu.org/devel/jit-spell.svg"/></a></p>
jit-spell is a spell-checking package for Emacs. It highlights all
misspelled words in a window, just like a word processor or web
@@ -38,29 +37,28 @@ the following to your init file:
#+end_src
To pick a spell checker and dictionaries, jit-spell uses Emacs's
-built-in ispell support code. Try =M-x customize-group ispell RET=
-to see a listing of all possible settings.
+built-in ispell support code. For instance,
+=ispell-change-dictionary= temporarily changes the dictionary of the
+current buffer. Try also =M-x customize-group RET ispell RET= to see
+a listing of all possible settings.
** Major mode support
-Some major modes require special settings to avoid checking irrelevant
-parts of the buffer.
+Often there are regions of the buffer that should be ignored for
+spell-checking purposes. In most cases, no additional configuration
+is necessary.
-The simplest mechanism to achieve that is the user option
+The simplest mechanism to make adjustments is the user option
=jit-spell-ignored-faces=. Any word fontified with one of these faces
-is ignored for spell-checking purposes. To find out which faces are
-present on a given character, you can use =M-x describe-char=.
+in this list ignored by jit-spell. To find out which faces are
+present on a given character, you can use the =describe-char= command.
In all programming language modes, spell checking is restricted to
-comments, docstring and strings. This can be modified by customizing
+comments, docstrings and strings. This can be modified by customizing
the variable =jit-spell-prog-mode-faces=.
-Some modes, such as Org and TeX-related modes, require more extensive
-adaptations. This is not yet provided as I am evaluating the possible
-approaches.
-
** Contributing
-Discussions, suggestions and code contributions are welcome! Since
+Discussions, suggestions and code contributions are welcome! Since
this package is part of GNU ELPA, contributions require a copyright
assignment to the FSF.
diff --git a/jit-spell.el b/jit-spell.el
index 8e4e2288e4..207dc00ea7 100644
--- a/jit-spell.el
+++ b/jit-spell.el
@@ -42,8 +42,8 @@
;; (define-key jit-spell-mode-map (kbd "C-;") 'jit-spell-correct-word))
;;
;; jit-spell relies on the `ispell' library to pick a spell checking
-;; program and dictionaries. Try `M-x customize-group ispell' to see
-;; a listing of all possible settings.
+;; program and dictionaries. Try `M-x customize-group RET ispell RET'
+;; to see a listing of all possible settings.
;;; Code: