[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] elpa-admin b25e1bf 039/357: Rephrase documentation and comments
From: |
Stefan Monnier |
Subject: |
[elpa] elpa-admin b25e1bf 039/357: Rephrase documentation and comments |
Date: |
Thu, 10 Dec 2020 18:06:11 -0500 (EST) |
branch: elpa-admin
commit b25e1bf10500085264e32f1dd9317c7da1f4b2ca
Author: Teemu Likonen <tlikonen@iki.fi>
Commit: Teemu Likonen <tlikonen@iki.fi>
Rephrase documentation and comments
---
README | 32 +++++++++++++++++---------------
1 file changed, 17 insertions(+), 15 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)
- [elpa] elpa-admin 0c6fbe0 307/357: Update packages/ack from upstream, (continued)
- [elpa] elpa-admin 0c6fbe0 307/357: Update packages/ack from upstream, Stefan Monnier, 2020/12/10
- [elpa] elpa-admin 370423c 026/357: * COPYING, ChangeLog, README, admin/org-synch.el,, Stefan Monnier, 2020/12/10
- [elpa] elpa-admin 20cbb20 002/357: * sml-mode.texi: somewhat updated the doc., Stefan Monnier, 2020/12/10
- [elpa] elpa-admin 6ee3dad 009/357: Added script and documentation for installing from CVS, Stefan Monnier, 2020/12/10
- [elpa] elpa-admin 102fabb 013/357: Start the Grand Unified Debugger Rewrite., Stefan Monnier, 2020/12/10
- [elpa] elpa-admin f545af1 036/357: Rephrase some parts of README, Stefan Monnier, 2020/12/10
- [elpa] elpa-admin 487ee79 022/357: Update README to note dependencies and what debugger's we've got., Stefan Monnier, 2020/12/10
- [elpa] elpa-admin 1761424 031/357: Use archive-contents.el script., Stefan Monnier, 2020/12/10
- [elpa] elpa-admin ce02925 001/357: Initial revision, Stefan Monnier, 2020/12/10
- [elpa] elpa-admin b824440 047/357: Minor rephrasing in README, Stefan Monnier, 2020/12/10
- [elpa] elpa-admin b25e1bf 039/357: Rephrase documentation and comments,
Stefan Monnier <=
- [elpa] elpa-admin 285d815 049/357: Fix last change., Stefan Monnier, 2020/12/10
- [elpa] elpa-admin 303f2c9 075/357: * admin/archive-contents.el (batch-make-site-package): New function., Stefan Monnier, 2020/12/10
- [elpa] elpa-admin dfa5808 053/357: Rework archive-contents.el to handle new packages/ structure., Stefan Monnier, 2020/12/10
- [elpa] elpa-admin 6c94727 068/357: archive-contents.el (archive--simple-package-p): Fix prop-line matching., Stefan Monnier, 2020/12/10
- [elpa] elpa-admin da7456c 065/357: write README in markdown, Stefan Monnier, 2020/12/10
- [elpa] elpa-admin 49fce77 070/357: Rename README to README.rst, Stefan Monnier, 2020/12/10
- [elpa] elpa-admin cbd75c6 082/357: README.md, load-relative.el: Go over documentation. Makefile.am: add targets test and test-short, Stefan Monnier, 2020/12/10
- [elpa] elpa-admin c497b5b 083/357: * GNUmakefile: Rename from Makefile. Add targets for in-place use., Stefan Monnier, 2020/12/10
- [elpa] elpa-admin 42c5112 084/357: * GNUmakefile (%.elc): Don't depend on $(autoloads) since that causes, Stefan Monnier, 2020/12/10
- [elpa] elpa-admin 480283a 089/357: Move check_copyright to the makefile, Stefan Monnier, 2020/12/10