all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Alan Mackenzie <acm@muc.de>
To: 56816@debbugs.gnu.org
Subject: bug#56816: Missing documentation of function-key-map
Date: Thu, 28 Jul 2022 19:30:36 +0000	[thread overview]
Message-ID: <YuLj3F3Ra7K418Fh@ACM> (raw)

Hello, Emacs.

function-key-map is not defined in the Elisp manual.

It is mentioned, in passing, on the page "Translation Keymaps" thusly:

     `local-function-key-map' inherits from `function-key-map'.  The
     latter should only be altered if you want the binding to apply in
     all terminals, so using the former is almost always preferred.

So, all we know about function-key-map is when to alter it (and even
here, it is unclear what the "all" in "all terminals" means).  Not what
it's for, not when it's looked up and used, not what its contents are.

#########################################################################

The doc string for function-key-map is a little better.  It, at least,
attempts to give a context for the variable ("The parent keymap of all
`local-function-key-map' instances.").

The doc string gives an example of what belongs in the variable
("Function key definitions that apply to all terminal devices should go
here."), but this doesn't define its contents.  It contains more than
function key definitions - for example, function keys with modifier keys,
and modifier keys on their own (for example, a binding for
event-apply-control-modifier).

These are all documentation bugs.

-- 
Alan Mackenzie (Nuremberg, Germany).





             reply	other threads:[~2022-07-28 19:30 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-07-28 19:30 Alan Mackenzie [this message]
2022-07-29  7:19 ` bug#56816: Missing documentation of function-key-map Eli Zaretskii
2022-07-29 19:50   ` Alan Mackenzie
2022-07-29 19:55     ` Gregory Heytings
2022-07-29 20:44       ` Alan Mackenzie
2022-07-30  6:43         ` Eli Zaretskii
2022-07-30  6:42     ` Eli Zaretskii
2022-07-30 15:29       ` 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

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=YuLj3F3Ra7K418Fh@ACM \
    --to=acm@muc.de \
    --cc=56816@debbugs.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 external index

	https://git.savannah.gnu.org/cgit/emacs.git
	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.