aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJuanma Barranquero2009-01-09 02:59:52 +0000
committerJuanma Barranquero2009-01-09 02:59:52 +0000
commit2188975fbff1202d011db2f82d728fc5fb5f9346 (patch)
tree761be312b758dce1e882f4cf1d24656482ac1300
parent543e6d09a25df504df1b0df90db10f5f3d9cb16a (diff)
downloademacs-2188975fbff1202d011db2f82d728fc5fb5f9346.tar.gz
emacs-2188975fbff1202d011db2f82d728fc5fb5f9346.zip
* textmodes/ispell.el (ispell-check-minver, ispell-last-program-name)
(ispell-html-skip-alists, ispell-send-replacement, ispell-show-choices) (ispell-begin-skip-region-regexp, ispell-skip-region-list) (ispell-ignore-fcc, ispell-skip-region, ispell-process-line) (ispell-horiz-scroll, ispell-mime-skip-part, ispell-buffer-local-words): Fix typos in docstrings. (ispell-command-loop): Reflow docstring.
-rw-r--r--lisp/ChangeLog10
-rw-r--r--lisp/textmodes/ispell.el32
2 files changed, 26 insertions, 16 deletions
diff --git a/lisp/ChangeLog b/lisp/ChangeLog
index 294cd7cb2ae..7ed2af86b1e 100644
--- a/lisp/ChangeLog
+++ b/lisp/ChangeLog
@@ -1,3 +1,13 @@
12009-01-09 Juanma Barranquero <lekktu@gmail.com>
2
3 * textmodes/ispell.el (ispell-check-minver, ispell-last-program-name)
4 (ispell-html-skip-alists, ispell-send-replacement, ispell-show-choices)
5 (ispell-begin-skip-region-regexp, ispell-skip-region-list)
6 (ispell-ignore-fcc, ispell-skip-region, ispell-process-line)
7 (ispell-horiz-scroll, ispell-mime-skip-part, ispell-buffer-local-words):
8 Fix typos in docstrings.
9 (ispell-command-loop): Reflow docstring.
10
12009-01-08 Agustín Martín <agustin.martin@hispalinux.es> 112009-01-08 Agustín Martín <agustin.martin@hispalinux.es>
2 12
3 * textmodes/ispell.el (ispell-encoding8-command): New variable 13 * textmodes/ispell.el (ispell-encoding8-command): New variable
diff --git a/lisp/textmodes/ispell.el b/lisp/textmodes/ispell.el
index de451133569..c31e965c9f0 100644
--- a/lisp/textmodes/ispell.el
+++ b/lisp/textmodes/ispell.el
@@ -204,8 +204,8 @@
204 (defalias 'ispell-check-minver 'version<=) 204 (defalias 'ispell-check-minver 'version<=)
205 (defun ispell-check-minver (minver version) 205 (defun ispell-check-minver (minver version)
206 "Check if string VERSION is at least string MINVER. 206 "Check if string VERSION is at least string MINVER.
207Both must be in [0-9]+.[0-9]+... format. This is a fallback 207Both must be in [0-9]+.[0-9]+... format. This is a fallback
208compatibility function in case version<= is not available." 208compatibility function in case `version<=' is not available."
209 (let ((pending t) 209 (let ((pending t)
210 (return t) 210 (return t)
211 start-ver start-mver) 211 start-ver start-mver)
@@ -1021,7 +1021,7 @@ Return the new dictionary alist."
1021;; Set params according to the selected spellchecker 1021;; Set params according to the selected spellchecker
1022 1022
1023(defvar ispell-last-program-name nil 1023(defvar ispell-last-program-name nil
1024 "Last value of ispell-program name. Internal use.") 1024 "Last value of `ispell-program-name'. Internal use.")
1025 1025
1026(defvar ispell-initialize-spellchecker-hook nil 1026(defvar ispell-initialize-spellchecker-hook nil
1027 "Normal hook run on spellchecker initialization. 1027 "Normal hook run on spellchecker initialization.
@@ -1443,7 +1443,7 @@ for skipping in latex mode.")
1443 ("<[^ \t\n>]" ">") 1443 ("<[^ \t\n>]" ">")
1444 ("&[^ \t\n;]" "[; \t\n]")) 1444 ("&[^ \t\n;]" "[; \t\n]"))
1445 "*Lists of start and end keys to skip in HTML buffers. 1445 "*Lists of start and end keys to skip in HTML buffers.
1446Same format as `ispell-skip-region-alist' 1446Same format as `ispell-skip-region-alist'.
1447Note - substrings of other matches must come last 1447Note - substrings of other matches must come last
1448 (e.g. \"<[tT][tT]/\" and \"<[^ \\t\\n>]\").") 1448 (e.g. \"<[tT][tT]/\" and \"<[^ \\t\\n>]\").")
1449(put 'ispell-html-skip-alists 'risky-local-variable t) 1449(put 'ispell-html-skip-alists 'risky-local-variable t)
@@ -1513,7 +1513,7 @@ pass it the output of the last ispell invocation."
1513 1513
1514(defun ispell-send-replacement (misspelled replacement) 1514(defun ispell-send-replacement (misspelled replacement)
1515 "Notify aspell that MISSPELLED should be spelled REPLACEMENT. 1515 "Notify aspell that MISSPELLED should be spelled REPLACEMENT.
1516This allows it to improve the suggestion list based on actual mispellings." 1516This allows it to improve the suggestion list based on actual misspellings."
1517 (and ispell-really-aspell 1517 (and ispell-really-aspell
1518 (ispell-send-string (concat "$$ra " misspelled "," replacement "\n")))) 1518 (ispell-send-string (concat "$$ra " misspelled "," replacement "\n"))))
1519 1519
@@ -1835,8 +1835,8 @@ Returns list for new replacement word (will be rechecked).
1835 Automatic query-replace when second element is `query-replace'. 1835 Automatic query-replace when second element is `query-replace'.
1836Highlights the word, which is assumed to run from START to END. 1836Highlights the word, which is assumed to run from START to END.
1837Global `ispell-pdict-modified-p' becomes a list where the only value 1837Global `ispell-pdict-modified-p' becomes a list where the only value
1838indicates whether the dictionary has been modified when option `a' or `i' is 1838indicates whether the dictionary has been modified when option `a'
1839used. 1839or `i' is used.
1840Global `ispell-quit' set to start location to continue spell session." 1840Global `ispell-quit' set to start location to continue spell session."
1841 (let ((count ?0) 1841 (let ((count ?0)
1842 (line ispell-choices-win-default-height) 1842 (line ispell-choices-win-default-height)
@@ -2117,7 +2117,7 @@ Global `ispell-quit' set to start location to continue spell session."
2117 2117
2118 2118
2119(defun ispell-show-choices (line end) 2119(defun ispell-show-choices (line end)
2120 "Shows the choices in another buffer or frame." 2120 "Show the choices in another buffer or frame."
2121 (if (and ispell-use-framepop-p (fboundp 'framepop-display-buffer)) 2121 (if (and ispell-use-framepop-p (fboundp 'framepop-display-buffer))
2122 (progn 2122 (progn
2123 (framepop-display-buffer (get-buffer ispell-choices-buffer)) 2123 (framepop-display-buffer (get-buffer ispell-choices-buffer))
@@ -2854,7 +2854,7 @@ Return nil if spell session is quit,
2854 2854
2855 2855
2856(defun ispell-begin-skip-region-regexp () 2856(defun ispell-begin-skip-region-regexp ()
2857 "Returns a regexp of the search keys for region skipping. 2857 "Return a regexp of the search keys for region skipping.
2858Includes `ispell-skip-region-alist' plus tex, tib, html, and comment keys. 2858Includes `ispell-skip-region-alist' plus tex, tib, html, and comment keys.
2859Must call after `ispell-buffer-local-parsing' due to dependence on mode." 2859Must call after `ispell-buffer-local-parsing' due to dependence on mode."
2860 ;; start with regions generic to all buffers 2860 ;; start with regions generic to all buffers
@@ -2923,7 +2923,7 @@ Generated from `ispell-tex-skip-alists'."
2923 2923
2924 2924
2925(defun ispell-skip-region-list () 2925(defun ispell-skip-region-list ()
2926 "Returns a list describing key and body regions to skip for this buffer. 2926 "Return a list describing key and body regions to skip for this buffer.
2927Includes regions defined by `ispell-skip-region-alist', tex mode, 2927Includes regions defined by `ispell-skip-region-alist', tex mode,
2928`ispell-html-skip-alists', and `ispell-checking-message'. 2928`ispell-html-skip-alists', and `ispell-checking-message'.
2929Manual checking must include comments and tib references. 2929Manual checking must include comments and tib references.
@@ -2957,7 +2957,7 @@ Must call after `ispell-buffer-local-parsing' due to dependence on mode."
2957 2957
2958 2958
2959(defun ispell-ignore-fcc (start end) 2959(defun ispell-ignore-fcc (start end)
2960 "Deletes the Fcc: message header when large attachments are included. 2960 "Delete the Fcc: message header when large attachments are included.
2961Return value `nil' if file with large attachments are saved. 2961Return value `nil' if file with large attachments are saved.
2962This can be used to avoid multiple questions for multiple large attachments. 2962This can be used to avoid multiple questions for multiple large attachments.
2963Returns point to starting location afterwards." 2963Returns point to starting location afterwards."
@@ -2984,7 +2984,7 @@ Returns point to starting location afterwards."
2984 2984
2985 2985
2986(defun ispell-skip-region (key) 2986(defun ispell-skip-region (key)
2987 "Skips across KEY and then to end of region. 2987 "Skip across KEY and then to end of region.
2988Key lookup determines region to skip. 2988Key lookup determines region to skip.
2989Point is placed at end of skipped region." 2989Point is placed at end of skipped region."
2990 ;; move over key to begin checking. 2990 ;; move over key to begin checking.
@@ -3069,7 +3069,7 @@ Point is placed at end of skipped region."
3069(defvar end) 3069(defvar end)
3070 3070
3071(defun ispell-process-line (string shift) 3071(defun ispell-process-line (string shift)
3072 "Sends STRING, a line of text, to ispell and processes the result. 3072 "Send STRING, a line of text, to ispell and processes the result.
3073This will modify the buffer for spelling errors. 3073This will modify the buffer for spelling errors.
3074Requires variables START and END to be defined in its lexical scope. 3074Requires variables START and END to be defined in its lexical scope.
3075Returns the sum SHIFT due to changes in word replacements." 3075Returns the sum SHIFT due to changes in word replacements."
@@ -3264,7 +3264,7 @@ Returns the sum SHIFT due to changes in word replacements."
3264 3264
3265;;; Horizontal scrolling 3265;;; Horizontal scrolling
3266(defun ispell-horiz-scroll () 3266(defun ispell-horiz-scroll ()
3267 "Places point within the horizontal visibility of its window area." 3267 "Place point within the horizontal visibility of its window area."
3268 (if truncate-lines ; display truncating lines? 3268 (if truncate-lines ; display truncating lines?
3269 ;; See if display needs to be scrolled. 3269 ;; See if display needs to be scrolled.
3270 (let ((column (- (current-column) (max (window-hscroll) 1)))) 3270 (let ((column (- (current-column) (max (window-hscroll) 1))))
@@ -3474,7 +3474,7 @@ Otherwise, it must be a function which is called to get the limit.")
3474 3474
3475 3475
3476(defun ispell-mime-skip-part (boundary) 3476(defun ispell-mime-skip-part (boundary)
3477 "Moves point across header, or entire MIME part if message is encoded. 3477 "Move point across header, or entire MIME part if message is encoded.
3478All specified types except `7bit' `8bit' and `quoted-printable' are considered 3478All specified types except `7bit' `8bit' and `quoted-printable' are considered
3479encoded and therefore skipped. See rfc 1521, 2183, ... 3479encoded and therefore skipped. See rfc 1521, 2183, ...
3480If no boundary is given, then entire message is skipped. 3480If no boundary is given, then entire message is skipped.
@@ -3796,7 +3796,7 @@ Both should not be used to define a buffer-local dictionary."
3796 3796
3797 3797
3798(defun ispell-buffer-local-words () 3798(defun ispell-buffer-local-words ()
3799 "Loads the buffer-local dictionary in the current buffer." 3799 "Load the buffer-local dictionary in the current buffer."
3800 ;; If there's an existing ispell process that's wrong for this use, 3800 ;; If there's an existing ispell process that's wrong for this use,
3801 ;; kill it. 3801 ;; kill it.
3802 (if (and ispell-buffer-local-name 3802 (if (and ispell-buffer-local-name