From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.ciao.gmane.io!not-for-mail From: Eli Zaretskii Newsgroups: gmane.emacs.bugs Subject: bug#40948: 26.3; Docstring of substitute-env-vars Date: Wed, 29 Apr 2020 14:14:11 +0300 Message-ID: <83lfmezgqk.fsf@gnu.org> References: Injection-Info: ciao.gmane.io; posting-host="ciao.gmane.io:159.69.161.202"; logging-data="29181"; mail-complaints-to="usenet@ciao.gmane.io" Cc: 40948@debbugs.gnu.org To: Marcus Harnisch , Stefan Monnier Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Wed Apr 29 13:15:13 2020 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1jTkgK-0007TL-Kg for geb-bug-gnu-emacs@m.gmane-mx.org; Wed, 29 Apr 2020 13:15:12 +0200 Original-Received: from localhost ([::1]:39284 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1jTkgJ-0003xc-Kp for geb-bug-gnu-emacs@m.gmane-mx.org; Wed, 29 Apr 2020 07:15:11 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:46634) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1jTkgB-0003wa-Eb for bug-gnu-emacs@gnu.org; Wed, 29 Apr 2020 07:15:03 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.90_1) (envelope-from ) id 1jTkgB-0004da-1Y for bug-gnu-emacs@gnu.org; Wed, 29 Apr 2020 07:15:03 -0400 Original-Received: from debbugs.gnu.org ([209.51.188.43]:59259) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1jTkgA-0004dT-LC for bug-gnu-emacs@gnu.org; Wed, 29 Apr 2020 07:15:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1jTkgA-0000eY-HS for bug-gnu-emacs@gnu.org; Wed, 29 Apr 2020 07:15:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Eli Zaretskii Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Wed, 29 Apr 2020 11:15:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 40948 X-GNU-PR-Package: emacs Original-Received: via spool by 40948-submit@debbugs.gnu.org id=B40948.15881588802465 (code B ref 40948); Wed, 29 Apr 2020 11:15:02 +0000 Original-Received: (at 40948) by debbugs.gnu.org; 29 Apr 2020 11:14:40 +0000 Original-Received: from localhost ([127.0.0.1]:42572 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1jTkfo-0000dh-Gj for submit@debbugs.gnu.org; Wed, 29 Apr 2020 07:14:40 -0400 Original-Received: from eggs.gnu.org ([209.51.188.92]:43500) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1jTkfm-0000dV-Qm for 40948@debbugs.gnu.org; Wed, 29 Apr 2020 07:14:39 -0400 Original-Received: from fencepost.gnu.org ([2001:470:142:3::e]:52751) by eggs.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1jTkfh-0004WB-7x; Wed, 29 Apr 2020 07:14:33 -0400 Original-Received: from [176.228.60.248] (port=3304 helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:RSA_AES_256_CBC_SHA1:256) (Exim 4.82) (envelope-from ) id 1jTkfd-0001Fr-VR; Wed, 29 Apr 2020 07:14:32 -0400 In-Reply-To: (message from Marcus Harnisch on Tue, 28 Apr 2020 22:22:52 +0200) X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-Received-From: 209.51.188.43 X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Original-Sender: "bug-gnu-emacs" Xref: news.gmane.io gmane.emacs.bugs:179299 Archived-At: > From: Marcus Harnisch > 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.