[Emacs-diffs] trunk r117198: Improve documentation for whitespace-report{, -region}

[Reuben Thomas]

------------------------------------------------------------
revno: 117198
revision-id: address@hidden
parent: address@hidden
committer: Reuben Thomas <address@hidden>
branch nick: trunk
timestamp: Thu 2014-05-29 23:43:26 +0100
message:
  Improve documentation for whitespace-report{,-region}
  
          * 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.
modified:
  lisp/ChangeLog                 changelog-20091113204419-o5vbwnq5f7feedwu-1432
  lisp/whitespace.el             
whitespace.el-20091113204419-o5vbwnq5f7feedwu-8268

=== modified file 'lisp/ChangeLog'
--- a/lisp/ChangeLog    2014-05-29 22:38:02 +0000
+++ b/lisp/ChangeLog    2014-05-29 22:43:26 +0000
@@ -1,6 +1,9 @@
 2014-05-29  Reuben Thomas  <address@hidden>
 
-       * 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  <address@hidden>
 

=== modified file 'lisp/whitespace.el'
--- a/lisp/whitespace.el        2014-05-29 22:38:02 +0000
+++ b/lisp/whitespace.el        2014-05-29 22:43:26 +0000
@@ -1719,36 +1719,7 @@
 (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))