Improve docstring.

This commit is contained in:
Vinicius Jose Latorre 2008-08-06 03:35:04 +00:00
parent 0e4cd8ded4
commit cd222e44e0
2 changed files with 33 additions and 11 deletions

View file

@ -1,3 +1,9 @@
2008-08-06 Vinicius Jose Latorre <viniciusjl@ig.com.br>
* whitespace.el (whitespace-newline-mode)
(global-whitespace-newline-mode, whitespace-mode)
(global-whitespace-mode): Improve docstring.
2008-08-05 Chong Yidong <cyd@stupidchicken.com>
* kmacro.el (kmacro-exec-ring-item): Add autoload.

View file

@ -161,10 +161,10 @@
;; There are also the following useful commands:
;;
;; `whitespace-newline-mode'
;; Toggle newline minor mode visualization ("nl" on modeline).
;; Toggle NEWLINE minor mode visualization ("nl" on modeline).
;;
;; `global-whitespace-newline-mode'
;; Toggle newline global minor mode visualization ("NL" on modeline).
;; Toggle NEWLINE global minor mode visualization ("NL" on modeline).
;;
;; `whitespace-report'
;; Report some blank problems in buffer.
@ -341,7 +341,7 @@
;; "long" lines. See EightyColumnRule (EmacsWiki).
;;
;; Thanks to Yanghui Bian <yanghuibian@gmail.com> for indicating a new
;; newline character mapping.
;; NEWLINE character mapping.
;;
;; Thanks to Pete Forman <pete.forman@westgeo.com> for indicating
;; whitespace-mode.el on XEmacs.
@ -1012,7 +1012,10 @@ Any other value is treated as nil."
If ARG is null, toggle whitespace visualization.
If ARG is a number greater than zero, turn on visualization;
otherwise, turn off visualization.
Only useful with a windowing system."
Only useful with a windowing system.
See also `whitespace-style', `whitespace-newline' and
`whitespace-display-mappings'."
:lighter " ws"
:init-value nil
:global nil
@ -1029,14 +1032,19 @@ Only useful with a windowing system."
;;;###autoload
(define-minor-mode whitespace-newline-mode
"Toggle newline minor mode visualization (\"nl\" on modeline).
"Toggle NEWLINE minor mode visualization (\"nl\" on modeline).
If ARG is null, toggle newline visualization.
If ARG is null, toggle NEWLINE visualization.
If ARG is a number greater than zero, turn on visualization;
otherwise, turn off visualization.
Only useful with a windowing system.
See also `whitespace-newline'."
Use `whitespace-newline-mode' only for NEWLINE visualization
exclusively. For other visualizations, including NEWLINE
visualization together with (HARD) SPACEs and/or TABs, please,
use `whitespace-mode'.
See also `whitespace-newline' and `whitespace-display-mappings'."
:lighter " nl"
:init-value nil
:global nil
@ -1058,7 +1066,10 @@ See also `whitespace-newline'."
If ARG is null, toggle whitespace visualization.
If ARG is a number greater than zero, turn on visualization;
otherwise, turn off visualization.
Only useful with a windowing system."
Only useful with a windowing system.
See also `whitespace-style', `whitespace-newline' and
`whitespace-display-mappings'."
:lighter " WS"
:init-value nil
:global t
@ -1107,14 +1118,19 @@ Only useful with a windowing system."
;;;###autoload
(define-minor-mode global-whitespace-newline-mode
"Toggle newline global minor mode visualization (\"NL\" on modeline).
"Toggle NEWLINE global minor mode visualization (\"NL\" on modeline).
If ARG is null, toggle newline visualization.
If ARG is null, toggle NEWLINE visualization.
If ARG is a number greater than zero, turn on visualization;
otherwise, turn off visualization.
Only useful with a windowing system.
See also `whitespace-newline'."
Use `global-whitespace-newline-mode' only for NEWLINE
visualization exclusively. For other visualizations, including
NEWLINE visualization together with (HARD) SPACEs and/or TABs,
please, use `global-whitespace-mode'.
See also `whitespace-newline' and `whitespace-display-mappings'."
:lighter " NL"
:init-value nil
:global t