unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: Drew Adams <drew.adams@oracle.com>
To: "Clément Pit--Claudel" <clement.pit@gmail.com>,
	"Emacs developers" <emacs-devel@gnu.org>
Subject: RE: Improving describe-mode and discoverability
Date: Thu, 23 Jun 2016 15:07:49 -0700 (PDT)	[thread overview]
Message-ID: <a9f2f153-f3d0-4bf6-826a-aa13648259f6@default> (raw)
In-Reply-To: <576C59AF.7080902@gmail.com>

> my proposal is to keep displaying mode docstrings. However, when a
> mode docstring includes a \\{mode-map} (which seems to be a very common
> thing to do), my proposal is to enhance the rendering of that \\{mode-map}
> construct to print an actually useful table.

So you are proposing a change to how \\{mode-map} is handled -
a replacement for the current behavior.

Personally, I don't have a problem with the way it is handled now.

I think that what you should do perhaps is to propose a new
(different) such construct, which produces the key binding plus
a one-line description instead of the key binding plus the command.

In that case, I probably wouldn't use that new construct, but
maybe others will.

To me, the key and the command name are the most important.
And the command names are linked to the full doc for the commands.

(And in my own code, keys between `..' are also so linked.)

> Of course, we could put this behaviour behind a flag.

If it is a new construct instead of a replacement for \\{...}
then there is no need for a flag.



  reply	other threads:[~2016-06-23 22:07 UTC|newest]

Thread overview: 15+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-06-23 18:29 Improving describe-mode and discoverability Clément Pit--Claudel
2016-06-23 18:46 ` Robert Weiner
2016-06-23 18:52   ` Clément Pit--Claudel
2016-06-23 19:11     ` Robert Weiner
2016-06-23 19:36       ` Clément Pit--Claudel
2016-06-23 20:26 ` Drew Adams
2016-06-23 21:50   ` Clément Pit--Claudel
2016-06-23 22:07     ` Drew Adams [this message]
2016-06-23 22:10       ` Dmitry Gutov
2016-06-23 22:27         ` Clément Pit--Claudel
2016-06-23 23:15           ` Drew Adams
2016-06-23 23:39             ` Clément Pit--Claudel
2016-06-24  0:05               ` Drew Adams
2016-06-24  2:59                 ` Clément Pit--Claudel
2016-07-06 17:47 ` John Wiegley

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=a9f2f153-f3d0-4bf6-826a-aa13648259f6@default \
    --to=drew.adams@oracle.com \
    --cc=clement.pit@gmail.com \
    --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).