unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: "Drew Adams" <drew.adams@oracle.com>
Subject: RE: Argument names in Elisp Reference vs docstrings
Date: Fri, 16 Sep 2005 16:19:38 -0700	[thread overview]
Message-ID: <DNEMKBNJBGPAOPIJOOICGEKACMAA.drew.adams@oracle.com> (raw)
In-Reply-To: <87slw4pro6.fsf@jurta.org>

    > I think it hasn't been decided whether to allow more than one
    default value
    > in the upcoming release.

    IIUC, Richard decided to allow more than one default value,
    since this is a quite trivial change.

I didn't realize this was already decided. Are these default values accessed
via repeated M-n? Is there any limit (or guideline) on their number?

    > In that case, "defaults" is misleading (that is, incorrect).
    > I suggest "default-value", which is clearer, anyway.
    > Similarly, I think "initial-value" or "init-value" is clearer than
    > "initial".

    I think neither "initial-value" nor "default-value" make the semantics
    of arguments clearer than "initial" or "default".  To understand the
    difference between them, programmers still should consult the
    documentation.

"default" is OK, if there is no problem with the C name conflict. "default"
is commonly abused as shorthand for "default value", at least in software.
(People speak of "the default".)

Yes, to understand the difference between an initial value and a default
value, the doc must be consulted, and that is true _regardless_ of the names
we use. That was not my point about "initial", however - I didn't claim that
"initial-value" would make that distinction clear.

My point was that "init" or "initial" does not by itself indicate an initial
_value_. There are other things that might be initial in this context.
"initial" is not clear in the same way that "default" is clear. People don't
say, "What is the "initial?"

All of the following are clearer than "initial": "init-val", "init-value",
"initial-value".

    > "Init" clearly stands for "initial", but the "value" part is
    > important - "initial" by itself doesn't mean much (initial what?).

    Perhaps simply "init" would be good: it's short, and since it is not
    a real word, it doesn't require a noun like "-value".

I don't get your response here. It's not because "initial" is a real word
that it requires a noun - it's because it's just an adjective. I granted
that "init" abbreviates "initial" adequately. The question is, initial what?
The "value" part is important. "init-val" takes only 2 more characters than
"initial", if that's the worry.

  reply	other threads:[~2005-09-16 23:19 UTC|newest]

Thread overview: 20+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2005-09-13 14:46 Argument names in Elisp Reference vs docstrings Juanma Barranquero
2005-09-14 14:08 ` Richard M. Stallman
2005-09-15 22:03   ` Juri Linkov
2005-09-16 12:02     ` Andreas Schwab
2005-09-16 22:14       ` Juri Linkov
2005-09-16 12:59     ` Richard M. Stallman
2005-09-16 22:16       ` Juri Linkov
2005-09-17 13:39         ` Richard M. Stallman
2005-09-17 14:30           ` Drew Adams
2005-09-17 20:20             ` Robert J. Chassell
2005-09-19 15:54               ` Drew Adams
2005-09-19 17:15                 ` Robert J. Chassell
2005-09-19  1:31             ` Richard M. Stallman
2005-09-19  8:04               ` Kim F. Storm
2005-09-16 14:59     ` Drew Adams
2005-09-16 15:28       ` Juanma Barranquero
2005-09-16 22:17       ` Juri Linkov
2005-09-16 23:19         ` Drew Adams [this message]
2005-09-16 23:48           ` Juri Linkov
2005-09-17  0:53             ` Drew Adams

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=DNEMKBNJBGPAOPIJOOICGEKACMAA.drew.adams@oracle.com \
    --to=drew.adams@oracle.com \
    /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).