bug#31713: 26.1.50; Docstring for 'empty' whitespace-style is clearer than manual

bug#31713: 26.1.50; Docstring for 'empty' whitespace-style is clearer than manual

[Basil L. Contovounesios]

Severity: minor

The 'empty' whitespace-style option is described under
"(emacs) Useless Whitespace" as follows:

  ‘empty’
       Highlight empty lines.

The docstring of whitespace-style, on the other hand, is a bit clearer
w.r.t. which lines are considered empty:

  empty                empty lines at beginning and/or end of buffer
                       are visualized via faces.
                       It has effect only if `face' (see above)
                       is present in `whitespace-style'.

I think the manual should also mention the BOB/EOB restriction.

Thanks,

-- 
Basil

In GNU Emacs 26.1.50 (build 1, x86_64-pc-linux-gnu, X toolkit, Xaw3d scroll bars)
 of 2018-06-03 built on thunk
Repository revision: 16e8541b743a6beb1926fef53cf1bfaed9c346db
Windowing system distributor 'The X.Org Foundation', version 11.0.11906000
System Description:	Debian GNU/Linux testing (buster)

bug#31713: 26.1.50; Docstring for 'empty' whitespace-style is clearer than manual

[Basil L. Contovounesios]

[-- Attachment #1: Type: text/plain, Size: 23 bytes --]

tags 31713 patch
quit


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-Improve-documentation-of-empty-whitespace-style.patch --]
[-- Type: text/x-diff, Size: 891 bytes --]

From 07fd69686c1a8a810d1d4e5a6f09f0785bdfa931 Mon Sep 17 00:00:00 2001
From: "Basil L. Contovounesios" <contovob@tcd.ie>
Date: Mon, 4 Jun 2018 17:39:40 +0100
Subject: [PATCH] Improve documentation of 'empty' whitespace-style

* doc/emacs/display.texi (Useless Whitespace): Clarify that the
'empty' whitespace-style option highlights empty lines only at
BOB/EOB, as per the docstring of whitespace-style. (bug#31713)
---
 doc/emacs/display.texi | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/doc/emacs/display.texi b/doc/emacs/display.texi
index c60cf64914..2f5ce80d60 100644
--- a/doc/emacs/display.texi
+++ b/doc/emacs/display.texi
@@ -1253,7 +1253,7 @@ Useless Whitespace
 Highlight newlines.
 
 @item empty
-Highlight empty lines.
+Highlight empty lines at the beginning and/or end of the buffer.
 
 @item big-indent
 @vindex whitespace-big-indent-regexp
-- 
2.17.1


[-- Attachment #3: Type: text/plain, Size: 717 bytes --]


"Basil L. Contovounesios" <contovob@tcd.ie> writes:

> The 'empty' whitespace-style option is described under
> "(emacs) Useless Whitespace" as follows:
>
>   ‘empty’
>        Highlight empty lines.
>
> The docstring of whitespace-style, on the other hand, is a bit clearer
> w.r.t. which lines are considered empty:
>
>   empty                empty lines at beginning and/or end of buffer
>                        are visualized via faces.
>                        It has effect only if `face' (see above)
>                        is present in `whitespace-style'.
>
> I think the manual should also mention the BOB/EOB restriction.

I attach a potential amendment.

Thanks,

-- 
Basil

bug#31713: 26.1.50; Docstring for 'empty' whitespace-style is clearer than manual

[Eli Zaretskii]

> From: "Basil L. Contovounesios" <contovob@tcd.ie>
> Date: Mon, 04 Jun 2018 18:06:01 +0100
> 
> tags 31713 patch
> quit
> 
> > The 'empty' whitespace-style option is described under
> > "(emacs) Useless Whitespace" as follows:
> >
> >   ‘empty’
> >        Highlight empty lines.
> >
> > The docstring of whitespace-style, on the other hand, is a bit clearer
> > w.r.t. which lines are considered empty:
> >
> >   empty                empty lines at beginning and/or end of buffer
> >                        are visualized via faces.
> >                        It has effect only if `face' (see above)
> >                        is present in `whitespace-style'.
> >
> > I think the manual should also mention the BOB/EOB restriction.
> 
> I attach a potential amendment.

Thanks, pushed.