unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: Lars Ingebrigtsen <larsi@gnus.org>
To: Stefan Monnier <monnier@iro.umontreal.ca>
Cc: emacs-devel@gnu.org
Subject: Re: Perhaps rearrange *Help* buffer a bit?
Date: Tue, 09 Jul 2019 15:58:40 +0200	[thread overview]
Message-ID: <m3sgrf8g33.fsf@gnus.org> (raw)
In-Reply-To: <jwv5zocaz3r.fsf-monnier+emacs@gnu.org> (Stefan Monnier's message of "Mon, 08 Jul 2019 19:30:21 -0400")

Stefan Monnier <monnier@iro.umontreal.ca> writes:

> Sounds about right, yes.  I think I'd vote to keep the function/macro
> distinction displayed by default at least (and maybe function/command as
> well).  Maybe simply as
>
>     Function: (car LIST) ...
>
>     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.

Yes, that makes sense -- whether something's a macro or not is pretty
important information.

> Maybe you're right.  Then again, I think it's worth keeping the block
> highlighted somehow to clearly indicate the difference between the
> docstring and the auto-generated metadata, maybe with a discreet
> background color.

Yes, that sounds good.

Should I perhaps just start a branch for this and start hacking?  This
is the sort of thing that'll probably take a lot of tweaks to get right,
because it's all about aesthetics and readability.

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no



  parent reply	other threads:[~2019-07-09 13:58 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 [this message]
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
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=m3sgrf8g33.fsf@gnus.org \
    --to=larsi@gnus.org \
    --cc=emacs-devel@gnu.org \
    --cc=monnier@iro.umontreal.ca \
    /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).