all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Stefan Monnier <monnier@iro.umontreal.ca>
Cc: Juanma Barranquero <jmbarranquero@wke.es>, emacs-devel@gnu.org
Subject: Re: convert-standard-filename's doc
Date: 27 May 2004 18:19:09 -0400	[thread overview]
Message-ID: <jwvisehldws.fsf-monnier+emacs@gnu.org> (raw)
In-Reply-To: <3099-Thu27May2004202140+0300-eliz@gnu.org>

>> 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.

> They don't need to be identical: once a port overloads the standard
> definition with another one, the doc string is replaced as well.

> So we could have a doc string that describes what that function does
> on the specific platform where it runs.  The default doc string
> should be left as it is now, IMHO.

I think the docstring should document what "the function
convert-standard-filename" does, not what the "the function currently
associated with the convert-standard-filename symbol" does.

So I think the "generic" text needs to be in, together with an explanation
of what this specific instance of convert-standard-filename does.

Basically I think that multiple definitions of the same function is
a bad thing.  Maybe using defadvice in dos-fns and w32-fns would be even
worse for various reasons, but I think that the docstrings should do
something similar to what we'd get if we used defadvice.


        Stefan

  reply	other threads:[~2004-05-27 22:19 UTC|newest]

Thread overview: 27+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2004-05-27 14:05 convert-standard-filename's doc Juanma Barranquero
2004-05-27 18:21 ` Eli Zaretskii
2004-05-27 22:19   ` Stefan Monnier [this message]
2004-05-28  9:02     ` Eli Zaretskii
2004-05-28 16:19       ` Stefan Monnier
2004-05-29 11:40         ` Eli Zaretskii
2004-05-28  9:27     ` Juanma Barranquero
2004-05-28 13:51       ` Kai Grossjohann
2004-05-28 18:26         ` Juanma Barranquero
2004-05-29 11:13           ` Kai Grossjohann
2004-05-29 14:24             ` Eli Zaretskii
2004-05-29 14:47               ` Kai Grossjohann
2004-05-29 17:55             ` Juanma Barranquero
2004-05-30 21:53               ` {Spam?} " Stefan Monnier
2004-05-31  7:05               ` Eli Zaretskii
2004-05-31  7:39                 ` Juanma Barranquero
2004-05-29 12:08           ` Eli Zaretskii
2004-05-28 16:21       ` Stefan Monnier
2004-05-29  0:49         ` Juanma Barranquero
2004-05-29 17:02         ` Richard Stallman
2004-05-29 17:56           ` Juanma Barranquero
2004-05-29 11:18     ` Kai Grossjohann
2004-05-30 14:30       ` Richard Stallman
2004-05-28  7:28   ` Juanma Barranquero
2004-05-29 10:16     ` Eli Zaretskii
2004-05-28  5:22 ` Kai Grossjohann
2004-05-28  9:32   ` Juanma Barranquero

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

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

  git send-email \
    --in-reply-to=jwvisehldws.fsf-monnier+emacs@gnu.org \
    --to=monnier@iro.umontreal.ca \
    --cc=emacs-devel@gnu.org \
    --cc=jmbarranquero@wke.es \
    /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 external index

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

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.