From: Eli Zaretskii <eliz@gnu.org>
To: Pedro Andres Aranda Gutierrez <paaguti@gmail.com>
Cc: stephen.berman@gmx.net, emacs-devel@gnu.org
Subject: Re: Small correction to commit ae2463796f236b8ee2cef3b5e38bffa13abd2233
Date: Fri, 06 Sep 2024 14:04:10 +0300 [thread overview]
Message-ID: <86ikv911sl.fsf@gnu.org> (raw)
In-Reply-To: <CAO48Bk-fcTXM_unaShjtyrX7eZLpTuMkHLbR+zS3OJ+JhrJkSw@mail.gmail.com> (message from Pedro Andres Aranda Gutierrez on Fri, 6 Sep 2024 10:13:20 +0200)
> From: Pedro Andres Aranda Gutierrez <paaguti@gmail.com>
> Date: Fri, 6 Sep 2024 10:13:20 +0200
> Cc: Eli Zaretskii <eliz@gnu.org>, emacs-devel@gnu.org
>
> I've continued thinking about this and have come up with:
>
> Make sure this
> evaluation does not load any files, or call functions like
> @code{posn-at-point} or @code{window-in-direction}, which themselves
> evaluate the mode line, as doing so could cause infinite recursion.
>
> or
>
> Make sure evaluating @var{form} does not load any files, or call functions like
> @code{posn-at-point} or @code{window-in-direction}, which themselves
> evaluate the mode line, as doing so could cause infinite recursion.
The current text says
Make sure this evaluation neither loads any files nor calls functions
like @code{posn-at-point} or @code{window-in-direction}, which
themselves evaluate the mode line, as doing so could cause infinite
recursion.
which I think is equivalent to what you suggest, but slightly less
ambiguous, grammar-wise.
> I personally would highlight this. Putting that in a separate paragraph may help
> or adding a bold *CAVEAT* before. My feeling is that being in the paragraph
> dilutes the importance of this kind of advices, not only here, but also in other
> places in the manuals. I know this can may take long, but IMHO this would improve
> the manuals a lot.
I don't see a reason to make each caveat in the manual stand out.
There are too many of them.
next prev parent reply other threads:[~2024-09-06 11:04 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-09-04 7:02 Small correction to commit ae2463796f236b8ee2cef3b5e38bffa13abd2233 Pedro Andres Aranda Gutierrez
2024-09-04 12:25 ` Eli Zaretskii
2024-09-04 13:55 ` Stephen Berman
2024-09-04 15:11 ` Stephen Berman
2024-09-06 8:13 ` Pedro Andres Aranda Gutierrez
2024-09-06 11:04 ` Eli Zaretskii [this message]
2024-09-07 5:17 ` Pedro Andres Aranda Gutierrez
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
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=86ikv911sl.fsf@gnu.org \
--to=eliz@gnu.org \
--cc=emacs-devel@gnu.org \
--cc=paaguti@gmail.com \
--cc=stephen.berman@gmx.net \
/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 external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.