branch: externals/guess-language
commit 3459b2747a5a98171407454682f487b64bd37ff2
Author: Titus von der Malsburg <[email protected]>
Commit: Titus von der Malsburg <[email protected]>
Updated doc strings.
---
guess-language.el | 33 ++++++++++++++++++++++-----------
1 file changed, 22 insertions(+), 11 deletions(-)
diff --git a/guess-language.el b/guess-language.el
index f4f364a..ea0f002 100644
--- a/guess-language.el
+++ b/guess-language.el
@@ -20,9 +20,20 @@
;;; Commentary:
-;; At this time, supported languages are English, French,
-;; German. Adding more languages is easy though. The detection
-;; algorithm is based on counts of character trigrams.
+;; Guess-language is a buffer-local minor mode. It guesses the
+;; language of the current paragraph when flyspell detects an
+;; incorrect word and changes ispell's dictionary and typo-mode
+;; accordingly. If the language settings change, flyspell is rerun
+;; but only on the current paragraph. Guess-language thus supports
+;; documents using multiple languages. If the paragraph is shorter
+;; than some user-defined value, none of the above happens because
+;; there is likely not enough text to guess the language correctly.
+;;
+;; The detection algorithm is based on counts of character
+;; trigrams. At this time, supported languages are English, French,
+;; German. Adding more languages is very easy, though, and this
+;; package already contains language statistics for 61 additional
+;; languages.
;; See here for more details:
;; https://github.com/tmalsburg/guess-language.el
@@ -104,8 +115,8 @@ little material to reliably guess the language."
(guess-language (region-beginning) (region-end)))
(defun guess-language-autoset ()
- "Detects language of the current paragraph and sets things like
-ispell dictionaries accordingly."
+ "Detects language of the current paragraph and changes updates
+ispell and typo mode accordingly."
(interactive)
(let* ((lang (guess-language-paragraph))
(codes (cdr (assoc lang guess-language-langcodes))))
@@ -135,12 +146,12 @@ A positive prefix argument enables the mode, any other
prefix
argument disables it. From Lisp, argument omitted or nil enables
the mode, `toggle' toggles the state.
-Guess-language mode is a buffer-local minor mode. When enabled,
-it guesses the language when flyspell detects words that are
-incorrectly and changes the ispell's dictionary and typo-mode
-accordingly. If the language settings change, flyspell is run on
-the current paragraph. If the paragraph is shorter than
-`guess-language-min-paragraph-length' none of the above happens
+Guess-language is a buffer-local minor mode. It guesses the
+language of the current paragraph when flyspell detects an
+incorrect word and changes ispell's dictionary and typo-mode
+accordingly. If the language settings change, flyspell is rerun
+on the current paragraph. If the paragraph is shorter than
+`guess-language-min-paragraph-length', none of the above happens
because there is likely not enough text to guess the language
correctly."
;; The initial value.
