GNU bug report logs - #48730
28.0.50; [PATCH] Add a documentation group section about buffer overlays

Previous Next

Package: emacs;

Reported by: Daniel Martín <mardani29 <at> yahoo.es>

Date: Sat, 29 May 2021 14:30:01 UTC

Severity: normal

Tags: patch

Found in version 28.0.50

Fixed in version 28.1

Done: Lars Ingebrigtsen <larsi <at> gnus.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 48730 in the body.
You can then email your comments to 48730 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#48730; Package emacs. (Sat, 29 May 2021 14:30:01 GMT) Full text and rfc822 format available.

Acknowledgement sent to Daniel Martín <mardani29 <at> yahoo.es>:
New bug report received and forwarded. Copy sent to bug-gnu-emacs <at> gnu.org. (Sat, 29 May 2021 14:30:01 GMT) Full text and rfc822 format available.

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

From: Daniel Martín <mardani29 <at> yahoo.es>
To: bug-gnu-emacs <at> gnu.org
Subject: 28.0.50; [PATCH] Add a documentation group section about buffer
 overlays
Date: Sat, 29 May 2021 16:29:16 +0200
[Message part 1 (text/plain, inline)]
I've attached to this mail two improvements for the documentation groups
feature that is new in GNU Emacs 28:

- Fixed a typo in the manual and improved a bit some explanations and
  docstrings that were not very clear to me when I read them.

- Added a new documentation group that describes what you can do with
  buffer overlays in Emacs (should we have a similar one for text
  properties?).

Thanks, I hope you find them useful.

[0001-Improve-the-documentation-of-documentation-groups.patch (text/x-patch, attachment)]
[0002-Add-a-new-documentation-group-for-overlays.patch (text/x-patch, attachment)]

Information forwarded to bug-gnu-emacs <at> gnu.org:
bug#48730; Package emacs. (Sat, 29 May 2021 14:55:01 GMT) Full text and rfc822 format available.

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

From: Eli Zaretskii <eliz <at> gnu.org>
To: Daniel Martín <mardani29 <at> yahoo.es>
Cc: 48730 <at> debbugs.gnu.org
Subject: Re: bug#48730: 28.0.50;
 [PATCH] Add a documentation group section about buffer overlays
Date: Sat, 29 May 2021 17:54:27 +0300
> Date: Sat, 29 May 2021 16:29:16 +0200
> From:  Daniel Martín via "Bug reports for GNU Emacs,
>  the Swiss army knife of text editors" <bug-gnu-emacs <at> gnu.org>
> 
> - Fixed a typo in the manual and improved a bit some explanations and
>   docstrings that were not very clear to me when I read them.

Thanks.  Not everything in this part is correct:

>  @example
>  :no-eval* (buffer-string)
>  @end example
>  
> -will result in:
> +will be printed as:

Not sure why this change is needed, they are equivalent, and your
variant uses passive tense, which we try to avoid.

> +For instance:
>  
>  @example
>  :no-eval (looking-at "f[0-9]")
>  :eg-result t
>  @end example
>  
> +will be printed as:

You need @noindent before the "will be printed" line.

> -By default, the function's actual argument list is shown.  If
> -@code{:args} is present, they are used instead.
> +By default, the function's actual argument list is shown.  If the
> +@code{:args} keyword is present, its value is shown instead.

I think the original reads better, FWIW.




Information forwarded to bug-gnu-emacs <at> gnu.org:
bug#48730; Package emacs. (Sat, 29 May 2021 16:01:02 GMT) Full text and rfc822 format available.

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

From: Daniel Martín <mardani29 <at> yahoo.es>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: 48730 <at> debbugs.gnu.org
Subject: Re: bug#48730: 28.0.50; [PATCH] Add a documentation group section
 about buffer overlays
Date: Sat, 29 May 2021 18:00:08 +0200
[Message part 1 (text/plain, inline)]
Eli Zaretskii <eliz <at> gnu.org> writes:

>> Date: Sat, 29 May 2021 16:29:16 +0200
>> From:  Daniel Martín via "Bug reports for GNU Emacs,
>>  the Swiss army knife of text editors" <bug-gnu-emacs <at> gnu.org>
>> 
>> - Fixed a typo in the manual and improved a bit some explanations and
>>   docstrings that were not very clear to me when I read them.
>
> Thanks.  Not everything in this part is correct:
>

Thanks.  I've reworked the first patch to avoid passive tense, include a
missing @noindent, and revert some rewording I did.

[0001-Improve-the-documentation-of-documentation-groups.patch (text/x-patch, attachment)]
[0002-Add-a-new-documentation-group-for-overlays.patch (text/x-patch, attachment)]

Information forwarded to bug-gnu-emacs <at> gnu.org:
bug#48730; Package emacs. (Sun, 30 May 2021 04:43:02 GMT) Full text and rfc822 format available.

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

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: Daniel Martín <mardani29 <at> yahoo.es>
Cc: 48730 <at> debbugs.gnu.org, Eli Zaretskii <eliz <at> gnu.org>
Subject: Re: bug#48730: 28.0.50; [PATCH] Add a documentation group section
 about buffer overlays
Date: Sun, 30 May 2021 06:42:04 +0200
Daniel Martín <mardani29 <at> yahoo.es> writes:

> Thanks.  I've reworked the first patch to avoid passive tense, include a
> missing @noindent, and revert some rewording I did.

Thanks; applied to Emacs 28.

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no




bug marked as fixed in version 28.1, send any further explanations to 48730 <at> debbugs.gnu.org and Daniel Martín <mardani29 <at> yahoo.es> Request was from Lars Ingebrigtsen <larsi <at> gnus.org> to control <at> debbugs.gnu.org. (Sun, 30 May 2021 04:43:02 GMT) Full text and rfc822 format available.

bug archived. Request was from Debbugs Internal Request <help-debbugs <at> gnu.org> to internal_control <at> debbugs.gnu.org. (Sun, 27 Jun 2021 11:24:06 GMT) Full text and rfc822 format available.

This bug report was last modified 2 years and 276 days ago.

Previous Next


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