* bug#4257: Documentation for where-is-preferred-modifier is obscure
@ 2009-08-25 16:24 Alan Mackenzie
2011-07-12 21:13 ` Lars Magne Ingebrigtsen
0 siblings, 1 reply; 2+ messages in thread
From: Alan Mackenzie @ 2009-08-25 16:24 UTC (permalink / raw)
To: bug-gnu-emacs
The doc string for `where-is-preferred-modifier' is
where-is-preferred-modifier is a variable defined in `C source code'.
Its value is nil
Documentation:
Preferred modifier to use for `where-is'.
When a single binding is requested, `where-is' will return one that
uses this modifier if possible. If nil, or if no such binding exists,
bindings using keys without modifiers (or only with meta) will be
preferred.
. This leaves the user having to guess what a "modifier for `where-is'"
is. This is bad.
The same obscurity exists in NEWS. This is somewhat bad.
The variable is not documented in the Emacs manual. This might be bad.
--
Alan Mackenzie (Nuremberg, Germany).
^ permalink raw reply [flat|nested] 2+ messages in thread
* bug#4257: Documentation for where-is-preferred-modifier is obscure
2009-08-25 16:24 bug#4257: Documentation for where-is-preferred-modifier is obscure Alan Mackenzie
@ 2011-07-12 21:13 ` Lars Magne Ingebrigtsen
0 siblings, 0 replies; 2+ messages in thread
From: Lars Magne Ingebrigtsen @ 2011-07-12 21:13 UTC (permalink / raw)
To: Alan Mackenzie; +Cc: 4257
Alan Mackenzie <acm@muc.de> writes:
> The doc string for `where-is-preferred-modifier' is
>
> where-is-preferred-modifier is a variable defined in `C source code'.
> Its value is nil
>
> Documentation:
> Preferred modifier to use for `where-is'.
> When a single binding is requested, `where-is' will return one that
> uses this modifier if possible. If nil, or if no such binding exists,
> bindings using keys without modifiers (or only with meta) will be
> preferred.
>
> . This leaves the user having to guess what a "modifier for `where-is'"
> is. This is bad.
By "modifier" they mean a modifier key. I've now clarified this in the
doc string in Emacs 24.
--
(domestic pets only, the antidote for overdose, milk.)
bloggy blog http://lars.ingebrigtsen.no/
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2011-07-12 21:13 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2009-08-25 16:24 bug#4257: Documentation for where-is-preferred-modifier is obscure Alan Mackenzie
2011-07-12 21:13 ` Lars Magne Ingebrigtsen
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).