From: Eli Zaretskii <eliz@gnu.org>
To: Stefan Kangas <stefan@marxist.se>,
Stefan Monnier <monnier@iro.umontreal.ca>
Cc: larsi@gnus.org, 46627@debbugs.gnu.org
Subject: bug#46627: [PATCH] Add new help command 'describe-command'
Date: Sat, 20 Feb 2021 10:18:31 +0200 [thread overview]
Message-ID: <83eehb17ag.fsf@gnu.org> (raw)
In-Reply-To: <CADwFkmmfiXSrTEBYvdU5smEXeDMMM9+W7ryrXD5TCPvNc3CvRg@mail.gmail.com> (message from Stefan Kangas on Fri, 19 Feb 2021 22:10:58 -0600)
> From: Stefan Kangas <stefan@marxist.se>
> Date: Fri, 19 Feb 2021 22:10:58 -0600
> Cc: 46627@debbugs.gnu.org, larsi@gnus.org
>
> > When a long text in |@kbd (or any other Texinfo markup) is near a
> > line's end, it is better to wrap it in @w{..}, so that it won't be
> > broken in half by the end of line.
>
> I tried wrapping it in @w{..} but I wasn't able to get it to avoid line
> breaks. Perhaps I'm doing something wrong, but I tried fixing these
> cases manually for now.
It's virtually impossible to fix that manually, as Info output and the
printed output have different line metrics and different line-breaking
algorithms. And even if you succeed to fix that manually, it will
break again after any slight change in wording.
The way to wrap it is like this:
@w{@kbd{C-h f make-vector @key{RET}}}
Is this what you tried? If so, how did it not work?
> >> + (unless (and fn (symbolp fn))
> >> + (user-error "You didn't specify a function symbol"))
> >> + (unless (or (fboundp fn) (get fn 'function-documentation))
> >> + (user-error "Symbol's function definition is void: %s" fn))
> >
> > These messages say "function" regardless of whether the user typed
> > "C-h x" or "C-h f". Is that optimal?
>
> Hmm, good point. I made an attempt at making this more user-friendly
> and less technical in the attached patch by introducing two new
> messages:
>
> 1. "You didn't specify a valid command name"
> 2. "No such command: %s"
>
> WDYT?
I'd prefer:
1. You didn't specify a command's symbol
2. Symbol is not a command: %s
> Hmm, but now that I'm testing this, I'm not sure how to arrive at these
> messages from `C-h x'.
You can't. To trigger these you must do some wizardry with
completion, to allow you to inject something that is not a function.
maybe Stefan Monnier (CC'ed) can help with setting that up.
> Should the more technical explanations therefore stay?
If it's 110% impossible to trigger those messages, they can go, of
course. The question is: can some completion trickery cause
completing-read return with a value that is either not a symbol or a
symbol whose function definition is void?
> ->> Try typing C-h f previous-line <Return>.
> +>> Try typing C-h x previous-line <Return>.
> This displays all the information Emacs has about the
> function which implements the C-p command.
Perhaps the text here should be amended not to mention "function".
Thanks.
next prev parent reply other threads:[~2021-02-20 8:18 UTC|newest]
Thread overview: 86+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-02-19 1:06 bug#46627: [PATCH] Add new help command 'describe-command' Stefan Kangas
2021-02-19 8:42 ` Eli Zaretskii
2021-02-19 17:42 ` Stefan Kangas
2021-02-19 18:38 ` bug#46627: [External] : " Drew Adams
2021-02-20 3:25 ` Stefan Kangas
2021-02-20 4:25 ` Drew Adams
2021-02-20 8:20 ` Eli Zaretskii
2021-02-20 7:44 ` Eli Zaretskii
2021-02-19 20:05 ` Eli Zaretskii
2021-02-20 4:10 ` Stefan Kangas
2021-02-20 8:18 ` Eli Zaretskii [this message]
2021-02-20 17:10 ` Stefan Kangas
2021-02-21 13:08 ` Lars Ingebrigtsen
2021-02-22 15:58 ` Eli Zaretskii
2021-04-28 13:58 ` Stefan Kangas
2021-04-28 14:17 ` Stefan Kangas
2021-05-02 13:14 ` Stefan Kangas
2021-02-20 12:56 ` Lars Ingebrigtsen
2021-02-20 12:59 ` Eli Zaretskii
2021-02-20 16:16 ` Eli Zaretskii
2021-02-20 14:04 ` Stefan Kangas
2021-02-20 16:06 ` Richard Stallman
2021-02-20 16:09 ` Eli Zaretskii
2021-02-20 20:06 ` bug#46627: [External] : " Drew Adams
2021-02-20 20:17 ` Eli Zaretskii
2021-02-20 20:54 ` Drew Adams
2021-02-20 16:39 ` Stefan Kangas
2021-02-20 16:49 ` Eli Zaretskii
2021-02-20 20:35 ` bug#46627: [External] : " Drew Adams
2021-02-20 20:46 ` Eli Zaretskii
2021-02-20 21:16 ` Drew Adams
2021-02-21 15:07 ` Eli Zaretskii
2021-02-21 17:55 ` Drew Adams
2021-02-21 18:11 ` Eli Zaretskii
2021-02-21 18:30 ` Drew Adams
2021-02-26 21:34 ` Drew Adams
2021-02-27 8:04 ` Eli Zaretskii
2021-02-27 17:46 ` Drew Adams
2021-02-21 6:19 ` Richard Stallman
2021-02-21 7:18 ` Stefan Kangas
2021-02-21 15:27 ` Eli Zaretskii
2021-02-21 16:39 ` Howard Melman
2021-02-21 18:01 ` bug#46627: [External] : " Drew Adams
2021-02-21 17:01 ` Stefan Kangas
2021-02-21 17:36 ` Eli Zaretskii
2021-02-21 18:02 ` Stefan Kangas
2021-02-21 18:21 ` Eli Zaretskii
2021-02-21 19:57 ` Dmitry Gutov
2021-02-21 20:13 ` Eli Zaretskii
2021-02-21 23:46 ` Dmitry Gutov
2021-02-22 15:18 ` Eli Zaretskii
2021-02-27 20:38 ` Dmitry Gutov
2021-02-28 17:27 ` Eli Zaretskii
2021-02-28 21:40 ` Dmitry Gutov
2021-03-01 6:05 ` Eli Zaretskii
2021-03-02 1:40 ` Dmitry Gutov
2021-03-02 5:31 ` Eli Zaretskii
2021-03-02 12:55 ` Dmitry Gutov
2021-03-02 13:47 ` Eli Zaretskii
2021-02-21 17:57 ` bug#46627: [External] : " Drew Adams
2021-02-21 17:33 ` Drew Adams
2021-02-21 13:06 ` Lars Ingebrigtsen
2021-02-21 6:27 ` Richard Stallman
2021-02-21 6:10 ` Richard Stallman
2021-02-21 6:27 ` Richard Stallman
2021-02-19 13:12 ` Lars Ingebrigtsen
2021-02-19 18:27 ` bug#46627: [External] : " Drew Adams
2021-02-19 18:43 ` Eli Zaretskii
2021-02-21 6:18 ` Richard Stallman
2021-02-21 6:27 ` Richard Stallman
2021-02-20 6:56 ` Richard Stallman
2021-02-20 7:14 ` Stefan Kangas
2021-02-21 6:19 ` Richard Stallman
2021-02-21 6:27 ` Richard Stallman
2021-02-21 7:17 ` Stefan Kangas
2021-02-22 6:23 ` Richard Stallman
2021-02-24 3:28 ` Stefan Kangas
2021-02-27 18:58 ` Dmitry Gutov
2021-03-01 5:18 ` Richard Stallman
2021-03-01 16:13 ` bug#46627: [External] : " Drew Adams
2021-03-02 6:29 ` Richard Stallman
2021-03-02 6:50 ` Eli Zaretskii
2021-03-03 5:55 ` Richard Stallman
2021-03-03 15:26 ` Drew Adams
2021-03-03 16:14 ` Eli Zaretskii
2021-03-02 16:52 ` Drew Adams
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=83eehb17ag.fsf@gnu.org \
--to=eliz@gnu.org \
--cc=46627@debbugs.gnu.org \
--cc=larsi@gnus.org \
--cc=monnier@iro.umontreal.ca \
--cc=stefan@marxist.se \
/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).