unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Eli Zaretskii <eliz@gnu.org>
To: "Daniel Martín" <mardani29@yahoo.es>
Cc: 48730@debbugs.gnu.org
Subject: bug#48730: 28.0.50; [PATCH] Add a documentation group section about buffer overlays
Date: Sat, 29 May 2021 17:54:27 +0300	[thread overview]
Message-ID: <83fsy5615o.fsf@gnu.org> (raw)
In-Reply-To: <m1mtsdobpf.fsf@yahoo.es> (bug-gnu-emacs@gnu.org)

> 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@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.





  reply	other threads:[~2021-05-29 14:54 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <m1mtsdobpf.fsf.ref@yahoo.es>
2021-05-29 14:29 ` bug#48730: 28.0.50; [PATCH] Add a documentation group section about buffer overlays Daniel Martín via Bug reports for GNU Emacs, the Swiss army knife of text editors
2021-05-29 14:54   ` Eli Zaretskii [this message]
2021-05-29 16:00     ` Daniel Martín via Bug reports for GNU Emacs, the Swiss army knife of text editors
2021-05-30  4:42       ` Lars Ingebrigtsen

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.gnu.org/software/emacs/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=83fsy5615o.fsf@gnu.org \
    --to=eliz@gnu.org \
    --cc=48730@debbugs.gnu.org \
    --cc=mardani29@yahoo.es \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).