[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: Argument names in Elisp Reference vs docstrings
From: |
Juri Linkov |
Subject: |
Re: Argument names in Elisp Reference vs docstrings |
Date: |
Sat, 17 Sep 2005 01:16:38 +0300 |
User-agent: |
Gnus/5.110004 (No Gnus v0.4) Emacs/22.0.50 (gnu/linux) |
> So I do not want to make these decisions in a blanket fashion.
> How about if you pick one of these groups of alternatives,
> make the changes to standardize that group, and send the diff here
> to be looked at?
I will send diffs for final reviews when most names will be basically
agreed.
> collection, table, alist
>
> I don't like "collection" very much.
"collection" is used in the Emacs Lisp Reference Manual for the
functions `try-completion', `all-completions', `test-completion'
and `completing-read'.
Perhaps a better name for this argument is "completions".
> nospace, hide-spaces
>
> "nospace" and "hide-spaces" suggest different meanings. I don't know
> how they are actually used, but it is possible that it is better to
> keep them both.
Both argument names are used for the same function `all-completions':
"hide-spaces" is used in the docstring, and "nospace" - in the
Emacs Lisp Reference Manual.
> history, hist
>
> The only possible reason not to change "hist" to "history"
> is to save space.
If the meaning of "hist" is as clear as "history", then it could
be used consistently in other functions as well.
> require-match, mustmatch, must-match, existing
>
> This seems like a good case to standardize, but it is possible
> that there is a reason to use "existing" in a specific case.
"existing" is used only in the Emacs Lisp Reference Manual.
--
Juri Linkov
http://www.jurta.org/emacs/
- Argument names in Elisp Reference vs docstrings, Juanma Barranquero, 2005/09/13
- Re: Argument names in Elisp Reference vs docstrings, Richard M. Stallman, 2005/09/14
- Re: Argument names in Elisp Reference vs docstrings, Juri Linkov, 2005/09/15
- Re: Argument names in Elisp Reference vs docstrings, Andreas Schwab, 2005/09/16
- Re: Argument names in Elisp Reference vs docstrings, Juri Linkov, 2005/09/16
- Re: Argument names in Elisp Reference vs docstrings, Richard M. Stallman, 2005/09/16
- Re: Argument names in Elisp Reference vs docstrings,
Juri Linkov <=
- Re: Argument names in Elisp Reference vs docstrings, Richard M. Stallman, 2005/09/17
- RE: Argument names in Elisp Reference vs docstrings, Drew Adams, 2005/09/17
- Re: Argument names in Elisp Reference vs docstrings, Robert J. Chassell, 2005/09/17
- RE: Argument names in Elisp Reference vs docstrings, Drew Adams, 2005/09/19
- Re: Argument names in Elisp Reference vs docstrings, Robert J. Chassell, 2005/09/19
- Re: Argument names in Elisp Reference vs docstrings, Richard M. Stallman, 2005/09/18
- Re: Argument names in Elisp Reference vs docstrings, Kim F. Storm, 2005/09/19
- RE: Argument names in Elisp Reference vs docstrings, Drew Adams, 2005/09/16
- Re: Argument names in Elisp Reference vs docstrings, Juanma Barranquero, 2005/09/16
- Re: Argument names in Elisp Reference vs docstrings, Juri Linkov, 2005/09/16