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: Mon, 19 Sep 2005 08:54:01 -0700	[thread overview]
Message-ID: <DNEMKBNJBGPAOPIJOOICGEKMCMAA.drew.adams@oracle.com> (raw)
In-Reply-To: <m1EGjAM-0004QmC@rattlesnake.com>

        [completions] doesn't quite fit for an alist, an obarray, or a
        hash table, or a function to test them.

    Unfortunately, `collection' does best.  `completions' fails utterly.
    Moreover, is not the focus on the whole group, not on its individual
    elements, members, or items?

    I agree, another word would be better, but `completions' is not it,
    nor are any of the words that direct attention to components.

There are at least two dimensions to consider here:

a. singular (collective) vs plural noun ("the whole group" vs its
"components")
b. meaning/use of argument vs its datatype

RMS on (b):

    In general, a name that describes the meaning is clearer than
    a name that describes only the data type

Is (a) more important than (b), in general, or even in this case? To me, (b)
is more important than (a), both in general and in this case. It is more
important to convey that the argument represents or manifests a set of
completions, than it is to worry about whether it names that set in a
singular or plural way.

Regardless of whether the datatype is alist, obarray, hash table, or
function, it represents an ordered set of completion candidates.

It's been said that use of a plural implies or suggests datatype `list'. I
think that's wrong, and is the root of the naming conundrum here. Plural
should simply indicate, well, plural! - that is, a collection.

The word "collection" doesn't tell us anything about what the argument
represents or is used for - it tells us only something (very little, in
fact) about how it is represented: it is some collective entity.

  reply	other threads:[~2005-09-19 15:54 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 [this message]
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
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=DNEMKBNJBGPAOPIJOOICGEKMCMAA.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).