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

Previous Next

Package: emacs;

Reported by: "Basil L. Contovounesios" <contovob <at> tcd.ie>

Date: Mon, 4 Jun 2018 16:57:02 UTC

Severity: minor

Tags: patch

Found in version 26.1.50

Done: Eli Zaretskii <eliz <at> gnu.org>

Bug is archived. No further changes may be made.

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 31713 in the body.
You can then email your comments to 31713 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

View this report as an mbox folder, status mbox, maintainer mbox


Report forwarded to bug-gnu-emacs <at> gnu.org:
bug#31713; Package emacs. (Mon, 04 Jun 2018 16:57:02 GMT) Full text and rfc822 format available.

Acknowledgement sent to "Basil L. Contovounesios" <contovob <at> tcd.ie>:
New bug report received and forwarded. Copy sent to bug-gnu-emacs <at> gnu.org. (Mon, 04 Jun 2018 16:57:02 GMT) Full text and rfc822 format available.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: "Basil L. Contovounesios" <contovob <at> tcd.ie>
To: bug-gnu-emacs <at> gnu.org
Subject: 26.1.50; Docstring for 'empty' whitespace-style is clearer than manual
Date: Mon, 04 Jun 2018 17:55:51 +0100
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)




Information forwarded to bug-gnu-emacs <at> gnu.org:
bug#31713; Package emacs. (Mon, 04 Jun 2018 17:07:01 GMT) Full text and rfc822 format available.

Message #8 received at 31713 <at> debbugs.gnu.org (full text, mbox):

From: "Basil L. Contovounesios" <contovob <at> tcd.ie>
To: 31713 <at> debbugs.gnu.org
Subject: Re: bug#31713: 26.1.50;
 Docstring for 'empty' whitespace-style is clearer than manual
Date: Mon, 04 Jun 2018 18:06:01 +0100
[Message part 1 (text/plain, inline)]
tags 31713 patch
quit

[0001-Improve-documentation-of-empty-whitespace-style.patch (text/x-diff, attachment)]
[Message part 3 (text/plain, inline)]
"Basil L. Contovounesios" <contovob <at> 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

Added tag(s) patch. Request was from "Basil L. Contovounesios" <contovob <at> tcd.ie> to control <at> debbugs.gnu.org. (Mon, 04 Jun 2018 17:07:02 GMT) Full text and rfc822 format available.

Reply sent to Eli Zaretskii <eliz <at> gnu.org>:
You have taken responsibility. (Tue, 05 Jun 2018 15:06:02 GMT) Full text and rfc822 format available.

Notification sent to "Basil L. Contovounesios" <contovob <at> tcd.ie>:
bug acknowledged by developer. (Tue, 05 Jun 2018 15:06:02 GMT) Full text and rfc822 format available.

Message #15 received at 31713-done <at> debbugs.gnu.org (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: "Basil L. Contovounesios" <contovob <at> tcd.ie>
Cc: 31713-done <at> debbugs.gnu.org
Subject: Re: bug#31713: 26.1.50;
 Docstring for 'empty' whitespace-style is clearer than manual
Date: Tue, 05 Jun 2018 18:05:21 +0300
> From: "Basil L. Contovounesios" <contovob <at> 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.




bug archived. Request was from Debbugs Internal Request <help-debbugs <at> gnu.org> to internal_control <at> debbugs.gnu.org. (Wed, 04 Jul 2018 11:24:05 GMT) Full text and rfc822 format available.

This bug report was last modified 7 years and 44 days ago.

Previous Next


GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.