procyberian/emacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Improve documentation for whitespace-report{,-region}

Browse source 
* whitespace.el (whitespace-report-region): Simplify
        documentation.
        (whitespace-report): Refer to whitespace-report-region's
        documentation.

This commit message also covers the previous commit, which was erroneously
committed with the log message "."; sorry.
This commit is contained in:
Reuben Thomas 2014-05-29 23:43:26 +01:00
parent 6ddcaa8f05
commit b0877c4488
2 changed files with 5 additions and 31 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
lisp/ChangeLog
View file

@ -1,6 +1,9 @@
2014-05-29 Reuben Thomas <rrt@sc3d.org>
* whitespace.el (whitespace-report): Simplify documentation.
* whitespace.el (whitespace-report-region): Simplify
documentation.
(whitespace-report): Refer to whitespace-report-region's
documentation.
2014-05-29 Stefan Monnier <monnier@iro.umontreal.ca>

31
lisp/whitespace.el
View file

@ -1719,36 +1719,7 @@ It is a cons of strings, where the car part is used when
(defun whitespace-report (&optional force report-if-bogus)
"Report some whitespace problems in buffer.
Return nil if there is no whitespace problem; otherwise, return
non-nil.
If FORCE is non-nil or \\[universal-argument] was pressed just
before calling `whitespace-report' interactively, it forces
`whitespace-style' to have:
empty
trailing
indentation
space-before-tab
space-after-tab
If REPORT-IF-BOGUS is non-nil, it reports only when there are any
whitespace problems in buffer.
Report if some of the following whitespace problems exist:
empty 1. empty lines at beginning of buffer.
empty 2. empty lines at end of buffer.
trailing 3. SPACEs or TABs at end of line.
space-before-tab 4. SPACEs before TAB.
space-after-tab 5. 8 or more SPACEs after TAB.
indentation 6. If `indent-tabs-mode':
8 or more SPACEs at beginning of line
else: TABS at beginning of line.
See `whitespace-style' for documentation.
See also `whitespace-cleanup' and `whitespace-cleanup-region' for
cleaning up these problems."
Perform `whitespace-report-region' on the current buffer."
(interactive (list current-prefix-arg))
(whitespace-report-region (point-min) (point-max)
force report-if-bogus))