From: Richard Stallman <rms@gnu.org>
Cc: emacs-devel@gnu.org
Subject: Re: Improved help from minibuffer prompts
Date: Tue, 20 Apr 2004 16:47:54 -0400 [thread overview]
Message-ID: <E1BG29q-0005Pj-5T@fencepost.gnu.org> (raw)
In-Reply-To: <FDELKNEBLPKKDCEBEJCBGEKBCDAA.drew.adams@oracle.com>
2) More importantly, we should make an effort (progressively) to create doc
strings that describe arguments first in a *user-centric* fashion. Nerdier
nitty-gritty explanations can be included in a doc string (if really
necessary - rare IMO), but they should come after a high-level,
user-understandable explanation. This effort would go a long way to solving
the perceived problem.
3) *Improve the prompts* for input arguments. A good prompt goes a long way
to helping users understand. I realize that some input args are so complex
that a user may need to understand more than can be put in a prompt, but
this can sometimes be an indicator that the command UI is in fact
ill-defined.
I agree completely. Anyone who has signed papers, please rewrite
doc strings in these ways whenever you feel you need a break
from fixing bugs.
4) Keeping in mind #2 & #3, I agree with some others that it can be useful
for a user to get to the whole doc string. Wouldn't it be sufficient to
remind a user about `C-h f' at the point of the argument "help" call?
That would be very inconvenient in practical use. We're considering
other suggestions that are much easier to use.
5) Often, a prefix arg (present/absent; positive, negative, zero; other
specific values) is very important to a command's functioning.
That is true. However,...
It would not
be explained by the proposed arg help;
Maybe so, but I don't follow your point. We're talking about offering
help for how to enter a minibuffer argument. Could you explain
precisely how the prefix arg relates to this?
users would have to consult the doc
string to get that info anyway. If they came to rely on the proposed arg
help, thinking they were getting the whole story that way, they would miss a
lot.
So what? We're talking about getting help for entering a minibuffer
argument.
7) In sum, I like the *solution* (delimit parts of doc strings, or otherwise
structure them), but I am not sure of the importance of the *problem* it
tries to solve.
Someone saw room for improvement, but I don't want to say I am certain
it is important. Perhaps things are good enough as they are.
next prev parent reply other threads:[~2004-04-20 20:47 UTC|newest]
Thread overview: 59+ messages / expand[flat|nested] mbox.gz Atom feed top
2004-04-13 6:26 Improved help from minibuffer prompts Stefan Reichör
2004-04-13 6:57 ` Miles Bader
2004-04-13 10:48 ` Stefan Reichör
2004-04-14 1:22 ` Miles Bader
2004-04-14 5:35 ` Stefan Reichör
2004-04-14 6:49 ` Miles Bader
2004-04-14 10:04 ` Kim F. Storm
2004-04-14 10:39 ` Stefan Reichör
2004-04-15 16:44 ` Richard Stallman
2004-04-16 6:15 ` Stefan Reichör
2004-04-16 10:04 ` Kim F. Storm
2004-04-16 13:12 ` Kai Grossjohann
2004-04-14 22:53 ` Richard Stallman
2004-04-15 1:23 ` Kim F. Storm
2004-04-16 18:08 ` Richard Stallman
2004-04-14 3:43 ` Masatake YAMATO
2004-04-14 18:02 ` Richard Stallman
2004-04-14 18:02 ` Richard Stallman
2004-04-15 5:50 ` Stefan Reichör
2004-04-16 18:07 ` Richard Stallman
2004-04-16 21:55 ` Kim F. Storm
2004-04-17 19:47 ` Richard Stallman
2004-04-19 7:51 ` Stefan Reichör
2004-04-19 11:50 ` Kim F. Storm
2004-04-29 23:48 ` Juanma Barranquero
2004-04-30 5:32 ` Stefan Reichör
2004-04-30 9:07 ` Juanma Barranquero
2004-05-01 17:51 ` Richard Stallman
2004-05-01 18:33 ` Juanma Barranquero
2004-05-02 19:52 ` Richard Stallman
2004-05-02 22:45 ` Juanma Barranquero
2004-05-03 22:20 ` Richard Stallman
2004-05-06 1:08 ` Juanma Barranquero
2004-05-06 14:13 ` Stefan Monnier
2004-05-07 1:11 ` Juanma Barranquero
2004-05-09 2:03 ` Juanma Barranquero
2004-05-07 0:29 ` Richard Stallman
2004-04-30 10:08 ` Kim F. Storm
2004-04-30 13:39 ` Juanma Barranquero
2004-04-30 15:50 ` Kim F. Storm
2004-04-30 22:20 ` Juanma Barranquero
2004-04-30 15:57 ` Stefan Monnier
2004-04-30 21:28 ` Juanma Barranquero
2004-04-30 22:49 ` Stefan Monnier
2004-05-01 2:17 ` Juanma Barranquero
2004-05-01 20:23 ` Stefan Monnier
2004-05-02 1:52 ` Juanma Barranquero
2004-05-04 0:32 ` Juanma Barranquero
2004-05-04 20:07 ` Richard Stallman
2004-05-04 22:52 ` Juanma Barranquero
2004-04-19 17:32 ` Drew Adams
2004-04-20 20:47 ` Richard Stallman [this message]
2004-04-20 23:13 ` Drew Adams
2004-04-21 6:25 ` Eli Zaretskii
2004-04-19 18:20 ` Richard Stallman
2004-04-16 18:07 ` Richard Stallman
2004-04-15 11:42 ` Matthew Mundell
2004-04-16 6:05 ` Stefan Reichör
2004-04-18 21:47 ` Richard Stallman
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=E1BG29q-0005Pj-5T@fencepost.gnu.org \
--to=rms@gnu.org \
--cc=emacs-devel@gnu.org \
/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).