Mercurial > emacs
changeset 97311:2be7f5365285
Improve docstring.
| author | Vinicius Jose Latorre <viniciusjl@ig.com.br> |
|---|---|
| date | Wed, 06 Aug 2008 03:35:04 +0000 |
| parents | 92e6692c8467 |
| children | aa4551463556 |
| files | lisp/ChangeLog lisp/whitespace.el |
| diffstat | 2 files changed, 33 insertions(+), 11 deletions(-) [+] |
line wrap: on
line diff
--- a/lisp/ChangeLog Wed Aug 06 03:23:55 2008 +0000 +++ b/lisp/ChangeLog Wed Aug 06 03:35:04 2008 +0000 @@ -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.
--- a/lisp/whitespace.el Wed Aug 06 03:23:55 2008 +0000 +++ b/lisp/whitespace.el Wed Aug 06 03:35:04 2008 +0000 @@ -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 @@ 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 @@ ;;;###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 @@ 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 @@ ;;;###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