unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Drew Adams <drew.adams@oracle.com>
To: Eli Zaretskii <eliz@gnu.org>
Cc: 34784@debbugs.gnu.org
Subject: bug#34784: 26.1; Doc of pseudofunction key `<timeout>'
Date: Fri, 8 Mar 2019 08:52:46 -0800 (PST)	[thread overview]
Message-ID: <b4181ab6-8e04-4851-b3cf-f63723ffcf6a@default> (raw)
In-Reply-To: <83imwta3t0.fsf@gnu.org>

> tags 34784 notabug
> thanks
> 
> > There is apparently a <timeout> function key and a `timeout'
> > function-key event?
> 
> There's no timeout function key, it's an event that CUA invented, a
> symbol, that's all.  See cua-base.el.  Any Lisp program can invent
> events of its liking and then inject those events and bind commands to
> them.

I thought that might be the case.

But according to how the Elisp manual talks about
function keys, "fake function keys", and events this
_is_ a function key: one that corresponds to the
`timeout' "event that CUA invented".  It's not a
function key that exists or is used outside CUA,
perhaps (that I wasn't sure about), but it is a
function key, at least in terms of how the manual
talks about such things.

Anyway, back to the point of this bug report: How
is a user to know this info about `<timeout>',
without digging into the code?

The doc speaks of "_fake_ function keys" for use in
menu items (only).  But the doc really doesn't guide
users when it comes to things like this.  Yes, it
talks, in the doc about events, about function-key
events, saying that the event is represented by the
function-key symbol.

But I don't see where the doc describes the kind of
thing that is happening with `C-c <timeout>'.  And
I don't see how a user would find out what that
function key (and it apparently is a function key
and not a fake function key) does, without digging
into the CUA code.

Maybe CUA needs, itself, to provide some help/doc
for users about this?  Or maybe Emacs can provide
some general mechanism for users to discover what
such an event does/means?

Keys in a key sequence that we present to a user
should be clear - including function keys.  We
document those that are common.  We don't document
`<timeout>'.  At least CUA should document it, I
think.

There should be some way for a user to find out
more about it, when `C-c C-h' shows it.  How does
a user type/use a key sequence such as
`C-c <timeout>'?  How does a user find that out?

Some user help is missing here.  You may have a
different/better idea of what is missing and where
it belongs, but don't you agree that something is
missing in terms of user help here?






  reply	other threads:[~2019-03-08 16:52 UTC|newest]

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-03-08  1:27 bug#34784: 26.1; Doc of pseudofunction key `<timeout>' Drew Adams
2019-03-08  1:29 ` Drew Adams
2019-03-08 13:33 ` Eli Zaretskii
2019-03-08 16:52   ` Drew Adams [this message]
2019-03-08 17:02     ` Eli Zaretskii
2020-08-24 19:22   ` Stefan Kangas
     [not found] <<247b0874-cbb1-40e1-996f-5f931c142616@default>
     [not found] ` <<83imwta3t0.fsf@gnu.org>
     [not found]   ` <<b4181ab6-8e04-4851-b3cf-f63723ffcf6a@default>
     [not found]     ` <<838sxp9u54.fsf@gnu.org>
2019-03-08 17:20       ` Drew Adams
2019-03-08 18:51         ` Eli Zaretskii
     [not found] <<<247b0874-cbb1-40e1-996f-5f931c142616@default>
     [not found] ` <<<83imwta3t0.fsf@gnu.org>
     [not found]   ` <<<b4181ab6-8e04-4851-b3cf-f63723ffcf6a@default>
     [not found]     ` <<<838sxp9u54.fsf@gnu.org>
     [not found]       ` <<f36457e6-0e75-4a6e-9aad-cb6bf2df1a46@default>
     [not found]         ` <<837ed99p36.fsf@gnu.org>
2019-03-08 19:39           ` Drew Adams
2019-03-08 19:48             ` Eli Zaretskii

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=b4181ab6-8e04-4851-b3cf-f63723ffcf6a@default \
    --to=drew.adams@oracle.com \
    --cc=34784@debbugs.gnu.org \
    --cc=eliz@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).