[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
doc string of execute-extended-command does not mention its argument
From: |
Drew Adams |
Subject: |
doc string of execute-extended-command does not mention its argument |
Date: |
Fri, 7 Jul 2006 08:31:18 -0700 |
The doc string of execute-extended-command should describe its
argument. What's needed is something like this, from the Elisp manual:
If the command asks for a prefix argument, it receives the value
PREFIX-ARGUMENT. If `execute-extended-command' is called
interactively, the current raw prefix argument is used for
PREFIX-ARGUMENT, and thus passed on to whatever command is run.
It is important for users using `C-h f execute-extended-command' to
get some explanation of the argument.
Also (a minor detail), the example in the Elisp manual is a particular
case, and can be misleading. It uses an argument value of 1, and shows
the `1' appearing in the prompt. But this is only the behavior with an
explicit argument; it is not what you see when you do just `M-x',
which gets an implicit arg of `1'. In that case, the `1' does not
appear in the prompt. It would be better for the Elisp example to use
another number, say, 2, because that represents the more general
case. An added detail would be to perhaps mention that in the case of
1 the value is only displayed when...
In GNU Emacs 22.0.50.1 (i386-mingw-nt5.1.2600)
of 2006-03-20 on W2ONE
X server distributor `Microsoft Corp.', version 5.1.2600
configured using `configure --with-gcc (3.4) --cflags -Id:/g/include'
Important settings:
value of $LC_ALL: nil
value of $LC_COLLATE: nil
value of $LC_CTYPE: nil
value of $LC_MESSAGES: nil
value of $LC_MONETARY: nil
value of $LC_NUMERIC: nil
value of $LC_TIME: nil
value of $LANG: ENU
locale-coding-system: cp1252
default-enable-multibyte-characters: t
Major mode: Help
Minor modes in effect:
encoded-kbd-mode: t
tooltip-mode: t
auto-compression-mode: t
tool-bar-mode: t
mouse-wheel-mode: t
menu-bar-mode: t
file-name-shadow-mode: t
global-font-lock-mode: t
font-lock-mode: t
blink-cursor-mode: t
unify-8859-on-encoding-mode: t
utf-translate-cjk-mode: t
line-number-mode: t
view-mode: t
Recent input:
<down-mouse-1> <mouse-1> <help-echo> <down-mouse-1>
<mouse-1> C-u 3 M-x C-g C-g C-g C-h k M-x <help-echo>
<help-echo> <down-mouse-1> <mouse-1> C-h f <return>
<help-echo> <help-echo> <help-echo> <help-echo> <help-echo>
<help-echo> <help-echo> <help-echo> <help-echo> <help-echo>
<help-echo> <help-echo> <help-echo> <help-echo> <help-echo>
<menu-bar> <help-menu> <report-emacs-bug>
Recent messages:
Loading encoded-kb...done
For information about the GNU Project and its goals, type C-h C-p.
Loading dired...
Loading regexp-opt...done
Loading dired...done
Quit [3 times]
Loading help-mode...done
Loading help-fns...done
Type C-x 1 to remove help window.
Loading emacsbug...done
- doc string of execute-extended-command does not mention its argument,
Drew Adams <=