bug-gnu-emacs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: convert-standard-filename documentation is insufficient


From: Eli Zaretskii
Subject: Re: convert-standard-filename documentation is insufficient
Date: Sun, 07 Nov 2004 06:41:17 +0200

> From: Jari Aalto <address@hidden>
> Date: Sat, 06 Nov 2004 20:07:07 +0200
> 
>     (convert-standard-filename FILENAME)
> 
>     Convert a standard file's name to something suitable for the
>     current OS. This function's standard definition is trivial; it
>     just returns the argument. However, on some systems, the function
>     is redefined with a definition that really does change some file
>     names.
> 
> This leaves completely open where function would be used.
> Please provide concrete examples in the documentation string.

This function was introduced for Lisp programmers, not for users.  The
rationale for its existence and its recommended usage are explained in
the ELisp manual (which will be part of the standard Emacs distro as
of the next release).

Given the above, I personally don't see any convincing reasons to add
the usage information to the doc string.




reply via email to

[Prev in Thread] Current Thread [Next in Thread]