From mboxrd@z Thu Jan 1 00:00:00 1970 Path: main.gmane.org!not-for-mail From: Stefan Monnier Newsgroups: gmane.emacs.devel Subject: Re: convert-standard-filename's doc Date: 27 May 2004 18:19:09 -0400 Sender: emacs-devel-bounces+emacs-devel=quimby.gnus.org@gnu.org Message-ID: References: <20040527152017.0849.JMBARRANQUERO@wke.es> <3099-Thu27May2004202140+0300-eliz@gnu.org> NNTP-Posting-Host: deer.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii X-Trace: sea.gmane.org 1085728908 27645 80.91.224.253 (28 May 2004 07:21:48 GMT) X-Complaints-To: usenet@sea.gmane.org NNTP-Posting-Date: Fri, 28 May 2004 07:21:48 +0000 (UTC) Cc: Juanma Barranquero , emacs-devel@gnu.org Original-X-From: emacs-devel-bounces+emacs-devel=quimby.gnus.org@gnu.org Fri May 28 09:21:40 2004 Return-path: Original-Received: from quimby.gnus.org ([80.91.224.244]) by deer.gmane.org with esmtp (Exim 3.35 #1 (Debian)) id 1BTbgR-0000aN-00 for ; Fri, 28 May 2004 09:21:40 +0200 Original-Received: from monty-python.gnu.org ([199.232.76.173]) by quimby.gnus.org with esmtp (Exim 3.35 #1 (Debian)) id 1BTbgR-0007tE-00 for ; Fri, 28 May 2004 09:21:39 +0200 Original-Received: from localhost ([127.0.0.1] helo=monty-python.gnu.org) by monty-python.gnu.org with esmtp (Exim 4.34) id 1BTaaa-0003iT-QU for emacs-devel@quimby.gnus.org; Fri, 28 May 2004 02:11:32 -0400 Original-Received: from list by monty-python.gnu.org with tmda-scanned (Exim 4.34) id 1BTXj4-0004QQ-5q for emacs-devel@gnu.org; Thu, 27 May 2004 23:08:06 -0400 Original-Received: from mail by monty-python.gnu.org with spam-scanned (Exim 4.34) id 1BTXdv-0003aL-QW for emacs-devel@gnu.org; Thu, 27 May 2004 23:03:19 -0400 Original-Received: from [132.204.24.67] (helo=mercure.iro.umontreal.ca) by monty-python.gnu.org with esmtp (Exim 4.34) id 1BTTDd-0004e5-Nv; Thu, 27 May 2004 18:19:21 -0400 Original-Received: from asado.iro.umontreal.ca (asado.iro.umontreal.ca [132.204.24.84]) by mercure.iro.umontreal.ca (Postfix) with ESMTP id 88393B3029D; Thu, 27 May 2004 18:19:09 -0400 (EDT) Original-Received: by asado.iro.umontreal.ca (Postfix, from userid 20848) id 77D568CA23; Thu, 27 May 2004 18:19:09 -0400 (EDT) Original-To: Eli Zaretskii In-Reply-To: <3099-Thu27May2004202140+0300-eliz@gnu.org> Original-Lines: 26 User-Agent: Gnus/5.09 (Gnus v5.9.0) Emacs/21.3.50 X-DIRO-MailScanner-Information: Please contact the ISP for more information X-DIRO-MailScanner: Found to be clean X-DIRO-MailScanner-SpamCheck: n'est pas un polluriel, SpamAssassin (score=0, requis 5) X-MailScanner-From: monnier@iro.umontreal.ca X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.4 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-devel-bounces+emacs-devel=quimby.gnus.org@gnu.org Xref: main.gmane.org gmane.emacs.devel:24061 X-Report-Spam: http://spam.gmane.org/gmane.emacs.devel:24061 >> Four years ago, the docstring for convert-standard-filename (in files.el) >> was changed, but the ones in w32-fns.el and dos-fns.el were not. >> >> Now, it's trivial to fix them to be identical again. > They don't need to be identical: once a port overloads the standard > definition with another one, the doc string is replaced as well. > So we could have a doc string that describes what that function does > on the specific platform where it runs. The default doc string > should be left as it is now, IMHO. I think the docstring should document what "the function convert-standard-filename" does, not what the "the function currently associated with the convert-standard-filename symbol" does. So I think the "generic" text needs to be in, together with an explanation of what this specific instance of convert-standard-filename does. Basically I think that multiple definitions of the same function is a bad thing. Maybe using defadvice in dos-fns and w32-fns would be even worse for various reasons, but I think that the docstrings should do something similar to what we'd get if we used defadvice. Stefan