all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Drew Adams <drew.adams@oracle.com>
To: Eli Zaretskii <eliz@gnu.org>, Drew Adams <drew.adams@oracle.com>
Cc: 30397@debbugs.gnu.org, juri@linkov.net
Subject: bug#30397: Random numbers in grep mode-line
Date: Fri, 9 Feb 2018 07:59:12 -0800 (PST)	[thread overview]
Message-ID: <571596f8-5f15-4b7e-b0b4-9842ea36aa7d@default> (raw)
In-Reply-To: <<83zi4i2n2o.fsf@gnu.org>>

> > If you agree that better help about this would be
> > in order, where would you suggest putting that help,
> > if not on `C-h m'?
> 
> Our current practice is to describe that in the manual.

That's OK by me.  Somewhere is better than nowhere.  The
manual is better than just NEWS.

> If we decide to add that to "C-h m", we should do that
> for all the modes.

That doesn't follow.

We sometimes describe some keys in `C-h m' output.  That
doesn't mean we should describe all keys in the mode map.

We should describe what needs to be described - in
particular, (1) things that might be the least obvious,
clear or easy to discover and (2) things that might be
the most important to know.

> We should also consider the discoverability:

Definitely.  That's why NEWS doesn't suffice.

The best discoverability for something in the mode-line
is mouseover tooltip info - right there.  The second best
is clicking that thing in the mode line - right there.

For mode indications in the mode-line, I do think that
`C-h m' would not be a bad place to describe them, when
the info is needed (i.e., when they are not clear on
their own and you cannot get more info about them from
the mode-line itself - see previous).

> "C-h m" is not where I would look for documentation
> of a mode, only for its keybindings.

Only its key bindings?  Not I.  To me, `C-h m' should
give an overview of the mode: what it's for etc.  If
`C-h m' for some mode just lists a few key bindings
then I'm disappointed and want more info.

`C-h m' is sometimes (often? typically?) the doc
string of the mode function.  As such, like any
command doc string, it should describe the command.

I mention these general thoughts about `C-h m' because
you brought up the general question.  I have no problem
with this bug being fixed by adding description in the
manual.  And perhaps modifiying what users see for
`grep' in the UI.





       reply	other threads:[~2018-02-09 15:59 UTC|newest]

Thread overview: 17+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <<<87tvurtbek.fsf@mail.linkov.net>
     [not found] ` <<<702f1621-529b-47b0-a15d-898a2fd81f79@default>
     [not found]   ` <<<83eflu4hjx.fsf@gnu.org>
     [not found]     ` <<3e9d0fd8-b859-4eec-8f34-54185dd6c0f3@default>
     [not found]       ` <<83zi4i2n2o.fsf@gnu.org>
2018-02-09 15:59         ` Drew Adams [this message]
     [not found] <<87tvurtbek.fsf@mail.linkov.net>
     [not found] ` <<702f1621-529b-47b0-a15d-898a2fd81f79@default>
     [not found]   ` <<83eflu4hjx.fsf@gnu.org>
2018-02-09 15:27     ` bug#30397: Random numbers in grep mode-line Drew Adams
2018-02-09 15:35       ` Eli Zaretskii
     [not found] ` <<83fu6a4hlh.fsf@gnu.org>
2018-02-09 15:43   ` Drew Adams
2018-02-08 21:32 Juri Linkov
2018-02-08 21:48 ` Drew Adams
2018-02-09  9:51   ` Eli Zaretskii
2018-02-08 23:00 ` Noam Postavsky
2018-02-10 21:32   ` Juri Linkov
2018-02-10 22:01     ` Drew Adams
2018-02-11 21:40       ` Juri Linkov
2018-02-12  4:54         ` Drew Adams
2018-02-12 15:47         ` Eli Zaretskii
2018-02-12 21:39           ` Juri Linkov
2018-02-11 20:45     ` Richard Stallman
2018-02-12 16:34       ` Eli Zaretskii
2018-02-09  9:50 ` Eli Zaretskii

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

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=571596f8-5f15-4b7e-b0b4-9842ea36aa7d@default \
    --to=drew.adams@oracle.com \
    --cc=30397@debbugs.gnu.org \
    --cc=eliz@gnu.org \
    --cc=juri@linkov.net \
    /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 external index

	https://git.savannah.gnu.org/cgit/emacs.git
	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.