[elpa] 259/352: Rephrase documentation and comments

[Stefan Monnier]

monnier pushed a commit to branch master
in repository elpa.

commit f84615f291ea29beed1d6df0e1f75cbac03449af
Author: Teemu Likonen <address@hidden>
Date:   Wed Jun 29 09:55:49 2011 +0300

    Rephrase documentation and comments
---
 README         |   32 +++++++++++++++++---------------
 wcheck-mode.el |   42 +++++++++++++++++++++++-------------------
 2 files changed, 40 insertions(+), 34 deletions(-)

diff --git a/README b/README
index 2a245fd..7f5d13d 100644
--- a/README
+++ b/README
@@ -5,10 +5,11 @@ Wcheck mode
 Introduction
 ------------
 
-Wcheck mode is a general-purpose text-checker interface for Emacs.
-Technically it's a minor mode which provides an on-the-fly text checker.
-It checks the visible text area as you type and possibly highlights some
-parts of it. What is checked and how, are all configurable.
+Wcheck mode is a general-purpose text-checker interface for Emacs text
+editor. Wcheck mode a minor mode which provides an on-the-fly text
+checker. It checks the visible text area, as you type, and possibly
+highlights some parts of it. What is checked and how are all
+configurable.
 
 Wcheck mode can use external programs or Emacs Lisp functions for
 checking text. For example, Wcheck mode can be used with spell-checker
@@ -23,10 +24,10 @@ Features
 --------
 
 In Wcheck mode's configuration different configuration units are called
-"languages". In terms of spelling checker it is natural to think of them
-as different human languages. That's only one point of view, though. In
-Wcheck mode language is just a configuration unit for certain kind of
-text checking purpose.
+"languages". In terms of a spelling checker it is natural to think of
+them as different human languages. Wcheck mode is not limited to that,
+though. Language is just a configuration unit for certain kind of text
+checking purpose.
 
 Each language can use its own checker engine (external program or a
 function), command-line arguments and other settings, such as the
@@ -49,13 +50,14 @@ activated either by (1) clicking the right mouse button on 
a marked text
 or (2) executing interactive command `wcheck-actions' while the cursor
 (the point) is on a marked text.
 
-If you use `wcheck-mode' as a spelling checker then it's natural to
+If you use Wcheck mode as a spelling checker then it's natural to
 configure an action menu that offers spelling suggestions for the
 misspelled word. The action menu could also have an option to add the
-word to spell-checker's dictionary, so that the word is recognized in
-the future. That's only one application for Wcheck mode, though. Wcheck
-mode can be configured to find almost any kind of text elements from
-buffer, mark them, and offer any kind of actions for marked text.
+marked word to spell-checker's dictionary, so that the word is
+recognized in the future. That's only one application for Wcheck mode,
+though. Wcheck mode can be configured to find almost any kind of text
+elements from buffer, mark them, and offer any kind of actions for
+marked text.
 
 
 How does it compare to other spell-checkers?
@@ -103,10 +105,10 @@ Configuration and basic usage
 
 The internal documentation of variable `wcheck-language-data' has a
 complete description on how to configure Wcheck mode language data. For
-easy configuration you can use the options in customize group named
+easy configuration you can use the options in the customize group named
 "wcheck" (M-x customize-group RET wcheck RET).
 
-It might be convenient if Wcheck mode commands are bound to some easily
+It might be convenient to bind Wcheck mode commands to some easily
 accessible keys, for example:
 
     (global-set-key (kbd "C-c s") 'wcheck-mode)
diff --git a/wcheck-mode.el b/wcheck-mode.el
index 29229bd..5598faf 100644
--- a/wcheck-mode.el
+++ b/wcheck-mode.el
@@ -1,6 +1,5 @@
-;;; wcheck-mode.el --- General interface for text checkers
+;;; wcheck-mode.el --- A general interface for text checkers
 
-;; Copyright (C) 2009-2011 Teemu Likonen <address@hidden>
 
 ;; Author: Teemu Likonen <address@hidden>
 ;; Maintainer: Teemu Likonen <address@hidden>
@@ -9,6 +8,8 @@
 ;; Keywords: text spell check languages ispell
 
 
+;; Copyright (C) 2009-2011 Teemu Likonen <address@hidden>
+;;
 ;; This program is free software: you can redistribute it and/or modify
 ;; it under the terms of the GNU General Public License as published by
 ;; the Free Software Foundation, either version 3 of the License, or (at
@@ -19,8 +20,7 @@
 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 ;; General Public License for more details.
 ;;
-;; You should have received a copy of the GNU General Public License
-;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
+;; The license text: <http://www.gnu.org/licenses/gpl-3.0.html>
 
 
 ;; INSTALLATION
@@ -45,17 +45,22 @@
 
 ;;; Commentary:
 ;;
-;; General interface for text checkers
+;; A general interface for text checkers
 ;;
-;; Wcheck is a minor mode for automatically checking and marking strings
-;; in Emacs buffer. Wcheck sends (parts of) buffer's content to a
-;; text-checker back-end and, based on its output, decides if some parts
-;; of text should be marked.
+;; Wcheck mode is a general-purpose text-checker interface for Emacs
+;; text editor. Wcheck mode a minor mode which provides an on-the-fly
+;; text checker. It checks the visible text area, as you type, and
+;; possibly highlights some parts of it. What is checked and how are all
+;; configurable.
 ;;
-;; Wcheck can be used with external spell-checker programs such as
-;; Ispell, Aspell and Enchant, but actually any tool that can receive
-;; text stream from standard input and send text to standard output can
-;; be used. The checker back-end can also be an Emacs Lisp function.
+;; Wcheck mode can use external programs or Emacs Lisp functions for
+;; checking text. For example, Wcheck mode can be used with
+;; spell-checker programs such as Ispell, Enchant and Hunspell, but
+;; actually any tool that can receive text from standard input stream
+;; and send text to standard output can be used. Wcheck mode sends parts
+;; of buffer's content to an external program or an Emacs Lisp function
+;; and, based on their output, decides if some parts of text should be
+;; marked in the buffer.
 
 
 ;;; Code:
@@ -1050,12 +1055,11 @@ receive text stream from standard input and send text 
to standard
 output can be used. The checker back-end can also be an Emacs
 Lisp function.
 
-In Wcheck mode different configuration units are called
-\"languages\". See the documentation of variables
-`wcheck-language-data', `wcheck-language-data-defaults' and
-`wcheck-language' for information on how to configure Wcheck
-mode. You can access the variables through customize group
-`wcheck'.
+Different configuration units are called \"languages\". See the
+documentation of variables `wcheck-language-data',
+`wcheck-language-data-defaults' and `wcheck-language' for
+information on how to configure Wcheck mode. You can access and
+configure the variables through customize group `wcheck'.
 
 Interactive command `wcheck-change-language' is used to switch
 languages. Command `wcheck-actions' gives an action menu for the