unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: "Eli Zaretskii" <eliz@gnu.org>
Cc: bug-gnu-emacs@gnu.org
Subject: Re: convert-standard-filename documentation is insufficient
Date: Sun, 07 Nov 2004 06:41:17 +0200	[thread overview]
Message-ID: <01c4c484$Blat.v2.2.2$2a742b40@zahav.net.il> (raw)
In-Reply-To: <ekj6am2c.fsf@blue.sea.net> (message from Jari Aalto on Sat, 06 Nov 2004 20:07:07 +0200)

> From: Jari Aalto <jari.aalto@cante.net>
> 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	other threads:[~2004-11-07  4:41 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2004-11-06 18:07 convert-standard-filename documentation is insufficient Jari Aalto
2004-11-07  4:41 ` Eli Zaretskii [this message]
  -- strict thread matches above, loose matches on Subject: below --
2004-11-07 22:00 Luc Teirlinck
2004-11-07 22:42 ` Eli Zaretskii
     [not found] <mailman.1099.1099774836.8225.bug-gnu-emacs@gnu.org>
2004-11-08 19:29 ` Stefan Monnier
2004-11-08 21:58 Luc Teirlinck
2004-11-08 22:02 Luc Teirlinck
2004-11-11 23:03 ` Jeff Dwork
2004-11-12  5:24   ` Werner LEMBERG
2004-11-12 13:34   ` Luc Teirlinck
2004-11-12 13:54   ` Luc Teirlinck

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.gnu.org/software/emacs/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to='01c4c484$Blat.v2.2.2$2a742b40@zahav.net.il' \
    --to=eliz@gnu.org \
    --cc=bug-gnu-emacs@gnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).