From b0877c4488a7a10e32e5602fc0b070222e773c02 Mon Sep 17 00:00:00 2001 From: Reuben Thomas Date: Thu, 29 May 2014 23:43:26 +0100 Subject: [PATCH] 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. --- lisp/ChangeLog | 5 ++++- lisp/whitespace.el | 31 +------------------------------ 2 files changed, 5 insertions(+), 31 deletions(-) diff --git a/lisp/ChangeLog b/lisp/ChangeLog index 6eb3aba5d22..12b194483ff 100644 --- a/lisp/ChangeLog +++ b/lisp/ChangeLog @@ -1,6 +1,9 @@ 2014-05-29 Reuben Thomas - * 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 diff --git a/lisp/whitespace.el b/lisp/whitespace.el index 72919340a29..c67733623dc 100644 --- a/lisp/whitespace.el +++ b/lisp/whitespace.el @@ -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)) -- 2.39.5