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

Previous Next

Full log

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.

Previous Next

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