diff options
| author | Chong Yidong <cyd@gnu.org> | 2012-09-22 23:24:26 +0800 |
|---|---|---|
| committer | Chong Yidong <cyd@gnu.org> | 2012-09-22 23:24:26 +0800 |
| commit | c88b867fecbd50140b0b41f05599811a8f0e3dfe (patch) | |
| tree | 945c6c88a7ce2029d13af7007239e8253e1e6a44 /lisp/emacs-lisp | |
| parent | bb4d86b40c61443608280df3d0668d44845177a5 (diff) | |
| download | emacs-c88b867fecbd50140b0b41f05599811a8f0e3dfe.tar.gz emacs-c88b867fecbd50140b0b41f05599811a8f0e3dfe.tar.bz2 emacs-c88b867fecbd50140b0b41f05599811a8f0e3dfe.zip | |
Misc doc fixes.
* searching.texi (Replacing Match): Minor clarification.
* lisp/repeat.el (repeat): Doc fix.
* lisp/simple.el (shell-command-on-region): Doc fix.
* lisp/emacs-lisp/easy-mmode.el (define-minor-mode): Doc fix.
* cmds.c (Fforward_char, Fbackward_char): Doc fix.
* editfns.c (Fline_beginning_position): Doc fix.
(Fline_end_position): Doc fix.
* minibuf.c (Finternal_complete_buffer): Doc fix.
* search.c (Freplace_match): Doc fix.
Fixes: debbugs:12325 debbugs:12391 debbugs:12416 debbugs:12414 debbugs:10909 debbugs:12348
Diffstat (limited to 'lisp/emacs-lisp')
| -rw-r--r-- | lisp/emacs-lisp/easy-mmode.el | 17 |
1 files changed, 11 insertions, 6 deletions
diff --git a/lisp/emacs-lisp/easy-mmode.el b/lisp/emacs-lisp/easy-mmode.el index ee4e36a9eba..4951368aebe 100644 --- a/lisp/emacs-lisp/easy-mmode.el +++ b/lisp/emacs-lisp/easy-mmode.el @@ -90,12 +90,17 @@ MODE (you can override this with the :variable keyword, see below). DOC is the documentation for the mode toggle command. The defined mode command takes one optional (prefix) argument. -Interactively with no prefix argument it toggles the mode. -With a prefix argument, it enables the mode if the argument is -positive and otherwise disables it. When called from Lisp, it -enables the mode if the argument is omitted or nil, and toggles -the mode if the argument is `toggle'. If DOC is nil this -function adds a basic doc-string stating these facts. +Interactively with no prefix argument, it toggles the mode. +A prefix argument enables the mode if the argument is positive, +and disables it otherwise. + +When called from Lisp, the mode command toggles the mode if the +argument is `toggle', disables the mode if the argument is a +non-positive integer, and enables the mode otherwise (including +if the argument is omitted or nil or a positive integer). + +If DOC is nil, give the mode command a basic doc-string +documenting what its argument does. Optional INIT-VALUE is the initial value of the mode's variable. Optional LIGHTER is displayed in the mode line when the mode is on. |