From mboxrd@z Thu Jan 1 00:00:00 1970 Path: main.gmane.org!not-for-mail From: Miles Bader Newsgroups: gmane.emacs.devel Subject: Re: substitute-in-file-name and "$" Date: Sun, 6 Jul 2003 08:44:11 -0400 Sender: emacs-devel-bounces+emacs-devel=quimby.gnus.org@gnu.org Message-ID: <20030706124411.GA28101@gnu.org> References: <200307052358.h65NwLs06030@raven.dms.auburn.edu> <848yrb6e3w.fsf@lucy.is.informatik.uni-duisburg.de> NNTP-Posting-Host: main.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii X-Trace: main.gmane.org 1057495453 30513 80.91.224.249 (6 Jul 2003 12:44:13 GMT) X-Complaints-To: usenet@main.gmane.org NNTP-Posting-Date: Sun, 6 Jul 2003 12:44:13 +0000 (UTC) Original-X-From: emacs-devel-bounces+emacs-devel=quimby.gnus.org@gnu.org Sun Jul 06 14:44:12 2003 Return-path: Original-Received: from quimby.gnus.org ([80.91.224.244]) by main.gmane.org with esmtp (Exim 3.35 #1 (Debian)) id 19Z8sG-0007w0-00 for ; Sun, 06 Jul 2003 14:44:12 +0200 Original-Received: from monty-python.gnu.org ([199.232.76.173]) by quimby.gnus.org with esmtp (Exim 3.12 #1 (Debian)) id 19Z91d-0003ec-00 for ; Sun, 06 Jul 2003 14:53:53 +0200 Original-Received: from localhost ([127.0.0.1] helo=monty-python.gnu.org) by monty-python.gnu.org with esmtp (Exim 4.20) id 19Z8sn-0000Wx-98 for emacs-devel@quimby.gnus.org; Sun, 06 Jul 2003 08:44:45 -0400 Original-Received: from list by monty-python.gnu.org with tmda-scanned (Exim 4.20) id 19Z8sR-0000Kz-1k for emacs-devel@gnu.org; Sun, 06 Jul 2003 08:44:23 -0400 Original-Received: from mail by monty-python.gnu.org with spam-scanned (Exim 4.20) id 19Z8sP-0000Ik-EM for emacs-devel@gnu.org; Sun, 06 Jul 2003 08:44:22 -0400 Original-Received: from fencepost.gnu.org ([199.232.76.164]) by monty-python.gnu.org with esmtp (Exim 4.20) id 19Z8sF-0008TT-Ao for emacs-devel@gnu.org; Sun, 06 Jul 2003 08:44:11 -0400 Original-Received: from miles by fencepost.gnu.org with local (Exim 4.20) id 19Z8sF-0007Y3-4a; Sun, 06 Jul 2003 08:44:11 -0400 Original-To: emacs-devel@gnu.org Content-Disposition: inline In-Reply-To: <848yrb6e3w.fsf@lucy.is.informatik.uni-duisburg.de> User-Agent: Mutt/1.3.28i Blat: Foop X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1b5 Precedence: list List-Id: Emacs development discussions. List-Help: List-Post: List-Subscribe: , List-Archive: List-Unsubscribe: , Errors-To: emacs-devel-bounces+emacs-devel=quimby.gnus.org@gnu.org Xref: main.gmane.org gmane.emacs.devel:15410 X-Report-Spam: http://spam.gmane.org/gmane.emacs.devel:15410 On Sun, Jul 06, 2003 at 02:20:35PM +0200, Kai Gro?johann wrote: > Now you are saying that docstrings should specify "I invoke > substitute-in-file-name" or "I do not invoke substitute-in-file-name". > > Clearly, down that path lies madness. Hardly. Whether or not a function calls substitute-in-file-name makes a fairly substantial difference in the result of the function. Since the docstring is supposed to say _what the function does_, it should surely mention if it expands environment variables or not (even if substitute-in-file-name were changed to be idempotent). Since most functions don't do such expansion, of course, only the ones that do need mention it. -Miles -- In New York, most people don't have cars, so if you want to kill a person, you have to take the subway to their house. And sometimes on the way, the train is delayed and you get impatient, so you have to kill someone on the subway. [George Carlin]