From: "Basil L. Contovounesios" <contovob@tcd.ie>
To: Lars Ingebrigtsen <larsi@gnus.org>
Cc: emacs-devel@gnu.org
Subject: Re: Perhaps rearrange *Help* buffer a bit?
Date: Mon, 08 Jul 2019 22:24:35 +0100 [thread overview]
Message-ID: <871rz0i5ik.fsf@tcd.ie> (raw)
In-Reply-To: <m3lfx81dql.fsf@gnus.org> (Lars Ingebrigtsen's message of "Mon, 08 Jul 2019 22:18:58 +0200")
Lars Ingebrigtsen <larsi@gnus.org> writes:
> I think Drew (or somebody?) mentioned this in a bug report the other
> day: The way the automated stuff is arranged in the *Help* buffer is
> perhaps not optimal.
>
> Consider:
>
> ----
>
> cadr is a compiled Lisp function in ‘subr.el’.
>
> (cadr X)
>
> This function has a compiler macro ‘internal--compiler-macro-cXXr’.
> Probably introduced at or before Emacs version 20.
>
> Return the car of the cdr of X.
>
> ----
>
> car is a built-in function in ‘C source code’.
>
> (car LIST)
>
> Probably introduced at or before Emacs version 1.2.
> This function does not change global state, including the match data.
>
> Return the car of LIST. If arg is nil, return nil.
> Error if arg is not nil and not a cons cell. See also ‘car-safe’.
>
> See Info node ‘(elisp)Cons Cells’ for a discussion of related basic
> Lisp concepts such as car, cdr, cons cell and list.
>
> ----
>
> So the thought here is that those indented lines isn't what's most
> interesting to the user. The compiler macro stuff is interesting to
> about two people in the world, and the "introduced at or before" to
> seven.
Don't forget me!
> What people want to know is the calling convention (line 3) and
> the stuff a human has lovingly written (starting in line 8 in both these
> examples).
And in the case of variables, the trailing "You can _customize_ this
variable" which indicates a user option.
And maybe also the indication of the presence of some advice on a named
function: ":around advice: `some-function@my-advice'"
And maybe some other usual suspects I'm forgetting about.
> The first line is perhaps not vital for people to know either, but since
> that's what I use to jump to function definitions, it's useful. (But
> perhaps a command that's just take us there is even better.)
The first line also indicates whether a function is interactive,
so I think it is useful for the average user.
> Anyway, what about rearranging this a bit so that the stuff the users
> are interested in comes first?
No objections here.
Thanks,
--
Basil
next prev parent reply other threads:[~2019-07-08 21:24 UTC|newest]
Thread overview: 15+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-07-08 20:18 Perhaps rearrange *Help* buffer a bit? Lars Ingebrigtsen
2019-07-08 20:29 ` Drew Adams
2019-07-08 20:31 ` Drew Adams
2019-07-08 21:14 ` Stefan Monnier
[not found] ` <m3bly4yxgq.fsf@gnus.org>
[not found] ` <jwv5zocaz3r.fsf-monnier+emacs@gnu.org>
2019-07-09 13:58 ` Lars Ingebrigtsen
2019-07-09 14:18 ` Stefan Monnier
2019-07-10 3:58 ` Howard Melman
2019-07-10 11:27 ` Lars Ingebrigtsen
2019-07-10 12:59 ` Howard Melman
2019-07-10 14:06 ` Drew Adams
2019-07-08 21:24 ` Basil L. Contovounesios [this message]
2019-07-08 22:38 ` Lars Ingebrigtsen
2019-07-09 0:02 ` Eric Abrahamsen
2019-07-09 0:59 ` Basil L. Contovounesios
2019-07-09 3:26 ` Eric Abrahamsen
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=871rz0i5ik.fsf@tcd.ie \
--to=contovob@tcd.ie \
--cc=emacs-devel@gnu.org \
--cc=larsi@gnus.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).