From: Eli Zaretskii <eliz@gnu.org>
To: Marcus Harnisch <marcus.harnisch@gmx.net>,
Stefan Monnier <monnier@iro.umontreal.ca>
Cc: 40948@debbugs.gnu.org
Subject: bug#40948: 26.3; Docstring of substitute-env-vars
Date: Wed, 29 Apr 2020 14:14:11 +0300 [thread overview]
Message-ID: <83lfmezgqk.fsf@gnu.org> (raw)
In-Reply-To: <e097b07d-70ad-3029-849d-f91d84faecfa@gmx.net> (message from Marcus Harnisch on Tue, 28 Apr 2020 22:22:52 +0200)
> From: Marcus Harnisch <marcus.harnisch@gmx.net>
> Date: Tue, 28 Apr 2020 22:22:52 +0200
>
> With commit ee041f2d07b6ed485dc34c115588f973f046c9d4, changes to the
> parameters of `substitute-env-vars' were introduced and its docstring
> changed. While the optional parameter is named WHEN-UNDEFINED, the
> docstring says WHEN-DEFINED. It would appear that the dosctring is
> right, but I'll leave that decision to the experts.
I modified the doc string to match the argument name. (I'm not sure
how to judge which one is correct, because IMO neither WHEN-DEFINED
nor WHEN-UNDEFINED is correct. I would call that argument
HANDLE-UNDEFINED or something to that effect.)
Also note that there's an inconsistency in how the value of this
variable is used: if it's a function, then the return value of nil
means leave the variable reference unchanged, but if it is not a
function, the value of nil means to replace the reference with an
empty string, and a non-nil value means leave it unchanged.
next prev parent reply other threads:[~2020-04-29 11:14 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-04-28 20:22 bug#40948: 26.3; Docstring of substitute-env-vars Marcus Harnisch
2020-04-29 11:14 ` Eli Zaretskii [this message]
2021-01-28 6:39 ` 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=83lfmezgqk.fsf@gnu.org \
--to=eliz@gnu.org \
--cc=40948@debbugs.gnu.org \
--cc=marcus.harnisch@gmx.net \
--cc=monnier@iro.umontreal.ca \
/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).