[Top][All Lists]

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

convert-standard-filename's doc

From: Juanma Barranquero
Subject: convert-standard-filename's doc
Date: Thu, 27 May 2004 16:05:36 +0200

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. But I wonder

    "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 to canonicalize certain
  patterns and to guarantee valid names."

is a good description for a function which really *does* something. In
other words, I'd change the docstring for the w32-fns.el version to

    "Convert a standard file's name to something suitable for Windows.

  Returns FILENAME after replacing invalid characters with ! and
  converting directory separators to the Windows style (if needed).
  It also turns Cygwin-style /cygdrive/x/ pathnames to x:/ paths."

(and add also a suitable docstring for the dos-fns.el version, of course).


reply via email to

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