GNU bug report logs - #40948
26.3; Docstring of substitute-env-vars

Previous Next

Package: emacs;

Reported by: Marcus Harnisch <marcus.harnisch <at> gmx.net>

Date: Tue, 28 Apr 2020 21:01:02 UTC

Severity: minor

Tags: fixed

Found in version 26.3

Fixed in version 28.1

Done: Lars Ingebrigtsen <larsi <at> gnus.org>

Bug is archived. No further changes may be made.

Full log


View this message in rfc822 format

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: Stefan Monnier <monnier <at> iro.umontreal.ca>, 40948 <at> debbugs.gnu.org, Marcus Harnisch <marcus.harnisch <at> gmx.net>
Subject: bug#40948: 26.3; Docstring of substitute-env-vars
Date: Thu, 28 Jan 2021 07:39:06 +0100
Eli Zaretskii <eliz <at> gnu.org> writes:

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

The interface seems odd indeed, but your changes to the doc string has
now made it match what it's doing (I think), so there doesn't seem to be
anything more to be done in this bug report, and I'm closing it.

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




This bug report was last modified 4 years and 115 days ago.

Previous Next


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