Re: disable-command (Re: [PATCH] Show/Hide menu)

[Karl Eichwalder]

Richard Stallman <address@hidden> writes:

> Why do you think so?  Please be specific.
> You may be right, but I cannot judge it
> (let alone consider possible solutions)
> without understanding what you see as the problem.

The user may not understand that the text following the first line ("You
have invoked the disabled command save-buffer:") explains the
command--maybe, I am wrong.  The rationale seems to be to display the
first paragraph of the docstring; with this paragraph is long, let us
hope the user is patient enough to read it.  I like a formatting like
this:

-=-=-=-=-=-=-=-=-=-=-=-=-=- cut here -=-=-=-=-=-=-=-=-=-=-=-=-=-

You have typed C-x C-s, invoking disabled command `save-buffer';
an explanation on `save-buffer' you can read below.

You can now type:
    Space to try the command just this once, but leave it disabled,
    Y to try it and enable it (no questions if you use it again),
    ! to try it and enable all commands in this session, or
    N to do nothing (command remains disabled).

Explanation on `save-buffer':
Save current buffer in visited file if modified.  Versions described below.
By default, makes the previous version into a backup file
 if previously requested or if this is the first save.
With 1 C-u, marks this version
 to become a backup when the next save is done.
With 2 C-u's,
 unconditionally makes the previous version into a backup file.
With 3 C-u's, marks this version
 to become a backup when the next save is done,
 and unconditionally makes the previous version into a backup file.

-=-=-=-=-=-=-=-=-=-=-=-=-=- cut here -=-=-=-=-=-=-=-=-=-=-=-=-=-

1. The explanation should come later.

2. Add a colon after "type".

3. Indent the item list of actions the user can choose from.

4. If you want to waste a little bit more vertical whitespace, add
   newlines after "type:" and "Explanation on `COMMAND'.

Maybe, my layout and punctation is too much inspired by European (or
German) tradition.  The longer I think about the current implementation
the more I'm incline to accept it as-is.

> Could you make a specific suggestion?

. Key combination and command: bold (^^^^^),
. Docstring paragraph: dark-blue (like the current mini-buffer prompt);
marker: (|),
. "You can now type": bold (^^^^^)

-=-=-=-=-=-=-=-=-=-=-=-=-=- cut here -=-=-=-=-=-=-=-=-=-=-=-=-=-
You have typed C-x C-s, invoking disabled command save-buffer:
               ^^^^^^^                            ^^^^^^^^^^^
|Save current buffer in visited file if modified.  Versions described below.
|By default, makes the previous version into a backup file
| if previously requested or if this is the first save.
|With 1 C-u, marks this version
| to become a backup when the next save is done.
|With 2 C-u's,
| unconditionally makes the previous version into a backup file.
|With 3 C-u's, marks this version
| to become a backup when the next save is done,
| and unconditionally makes the previous version into a backup file.


You can now type
^^^^^^^^^^^^^^^^
Space to try the command just this once, but leave it disabled,
Y to try it and enable it (no questions if you use it again),
! to try it and enable all commands in this session, or
N to do nothing (command remains disabled).
-=-=-=-=-=-=-=-=-=-=-=-=-=- cut here -=-=-=-=-=-=-=-=-=-=-=-=-=-


-- 
address@hidden (work) / address@hidden (home):              |
http://www.suse.de/~ke/                                  |      ,__o
Free Translation Project:                                |    _-\_<,
http://www.iro.umontreal.ca/contrib/po/HTML/             |   (*)/'(*)