From mboxrd@z Thu Jan 1 00:00:00 1970 Path: main.gmane.org!not-for-mail From: Luc Teirlinck Newsgroups: gmane.emacs.bugs Subject: Re: convert-standard-filename documentation is insufficient Date: Sun, 7 Nov 2004 16:00:02 -0600 (CST) Message-ID: <200411072200.iA7M02V02132@raven.dms.auburn.edu> NNTP-Posting-Host: deer.gmane.org X-Trace: sea.gmane.org 1099864851 23573 80.91.229.6 (7 Nov 2004 22:00:51 GMT) X-Complaints-To: usenet@sea.gmane.org NNTP-Posting-Date: Sun, 7 Nov 2004 22:00:51 +0000 (UTC) Cc: bug-gnu-emacs@gnu.org Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Sun Nov 07 23:00:42 2004 Return-path: Original-Received: from lists.gnu.org ([199.232.76.165]) by deer.gmane.org with esmtp (Exim 3.35 #1 (Debian)) id 1CQv5V-00039T-00 for ; Sun, 07 Nov 2004 23:00:42 +0100 Original-Received: from localhost ([127.0.0.1] helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.33) id 1CQvDp-0002Ok-LY for geb-bug-gnu-emacs@m.gmane.org; Sun, 07 Nov 2004 17:09:17 -0500 Original-Received: from mailman by lists.gnu.org with tmda-scanned (Exim 4.33) id 1CQvDn-0002OF-AC for bug-gnu-emacs@gnu.org; Sun, 07 Nov 2004 17:09:15 -0500 Original-Received: from exim by lists.gnu.org with spam-scanned (Exim 4.33) id 1CQvDm-0002Np-H2 for bug-gnu-emacs@gnu.org; Sun, 07 Nov 2004 17:09:14 -0500 Original-Received: from [199.232.76.173] (helo=monty-python.gnu.org) by lists.gnu.org with esmtp (Exim 4.33) id 1CQvDm-0002Nl-CB for bug-gnu-emacs@gnu.org; Sun, 07 Nov 2004 17:09:14 -0500 Original-Received: from [131.204.53.104] (helo=manatee.dms.auburn.edu) by monty-python.gnu.org with esmtp (Exim 4.34) id 1CQv5O-000654-5o; Sun, 07 Nov 2004 17:00:34 -0500 Original-Received: from raven.dms.auburn.edu (raven.dms.auburn.edu [131.204.53.29]) by manatee.dms.auburn.edu (8.12.10/8.12.10) with ESMTP id iA7M0XFu018422; Sun, 7 Nov 2004 16:00:33 -0600 (CST) Original-Received: (from teirllm@localhost) by raven.dms.auburn.edu (8.11.7p1+Sun/8.11.7) id iA7M02V02132; Sun, 7 Nov 2004 16:00:02 -0600 (CST) X-Authentication-Warning: raven.dms.auburn.edu: teirllm set sender to teirllm@dms.auburn.edu using -f Original-To: "Eli Zaretskii" X-BeenThere: bug-gnu-emacs@gnu.org X-Mailman-Version: 2.1.5 Precedence: list List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Original-Sender: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Xref: main.gmane.org gmane.emacs.bugs:9620 X-Report-Spam: http://spam.gmane.org/gmane.emacs.bugs:9620 Eli Zaretskii wrote: Given the above, I personally don't see any convincing reasons to add the usage information to the doc string. Actually, the docstring appears to have already been expanded in current CVS: "Convert a standard file's name to something suitable for the current OS. This means to guarantee valid names and perhaps to canonicalize certain patterns. This function's standard definition is trivial; it just returns the argument. However, on Windows and DOS, replace invalid characters. On DOS, make sure to obey the 8.3 limitations. On Windows, turn Cygwin names into native names, and also turn slashes into backslashes if the shell requires it (see `w32-shell-dos-semantics')." I would propose a small change in the 72 character first line. Replace `something' by `one'. This brings it down to 66 characters, which is within the maximum allowed 67 and looks better in the `apropos' output: Convert a standard file's name to one suitable for the current OS. If there are no objections, I will install this change in CVS. Sincerely, Luc.