[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: convert-standard-filename documentation is insufficient
From: |
Luc Teirlinck |
Subject: |
Re: convert-standard-filename documentation is insufficient |
Date: |
Sun, 7 Nov 2004 16:00:02 -0600 (CST) |
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.