unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Drew Adams <drew.adams@oracle.com>
To: Phil Sainty <psainty@orcon.net.nz>
Cc: Stephen Berman <stephen.berman@gmx.net>,
	32212@debbugs.gnu.org,
	bug-gnu-emacs
	<bug-gnu-emacs-bounces+psainty=orcon.net.nz@gnu.org>,
	Noam Postavsky <npostavs@gmail.com>
Subject: bug#32212: 26; `subword-mode' doc string shows empty key-binding list
Date: Sun, 22 Jul 2018 21:19:55 -0700 (PDT)	[thread overview]
Message-ID: <bf673619-1367-4690-b903-8303223ee2b0@default> (raw)
In-Reply-To: <bb6aedf55174a586e200c0ff1d3ddcad@webmail.orcon.net.nz>

> >> Would it be better if the \\{some-keymap} substitution handled the
> >> case where there were no bindings, and printed nothing?
> >
> > No.  A doc string can introduce the list of bindings any
> > way its author wants.  We cannot predict what text might
> > precede or follow the text \\{some-keymap}.
> 
> Ah, yes, agreed -- a search shows quite a variety of such introductory
> phrases:...
> 
> I think there's a lot of unnecessary inconsistency here which would
> probably benefit from a common phrasing.  That could feasibly be
> provided via an alternative variant of the \\{...} syntax (at which
> point it could make more sense to include some automated variations
> for edge cases), but that all sounds like more trouble than it's
> worth, so I'm not really suggesting that this should be done (even
> if it strikes me as a "nice to have").

Agreed on all counts.  Except that before thinking about
variants of \\{...} (YAGNI), I'd say that if you think
such inconsistency is really a problem then the best fix
is to suggest a convention to users in the manual.

(But I don't think such inconsistency is a problem.)





  reply	other threads:[~2018-07-23  4:19 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-07-19 15:10 bug#32212: 26; `subword-mode' doc string shows empty key-binding list Drew Adams
2018-07-20  0:58 ` Noam Postavsky
2018-07-20  7:01   ` Eli Zaretskii
2018-07-20  8:38     ` Stephen Berman
2018-07-22 20:22       ` Noam Postavsky
2018-07-22 22:36         ` Phil Sainty
2018-07-23  1:01           ` Drew Adams
2018-07-23  4:15             ` Phil Sainty
2018-07-23  4:19               ` Drew Adams [this message]
2018-07-23  2:26         ` Eli Zaretskii
2018-07-23 12:22           ` Noam Postavsky

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=bf673619-1367-4690-b903-8303223ee2b0@default \
    --to=drew.adams@oracle.com \
    --cc=32212@debbugs.gnu.org \
    --cc=bug-gnu-emacs-bounces+psainty=orcon.net.nz@gnu.org \
    --cc=npostavs@gmail.com \
    --cc=psainty@orcon.net.nz \
    --cc=stephen.berman@gmx.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 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).