all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Drew Adams <drew.adams@oracle.com>
To: Stefan Kangas <stefan@marxist.se>,
	Michael Heerdegen <michael_heerdegen@web.de>,
	Lars Ingebrigtsen <larsi@gnus.org>
Cc: 15917@debbugs.gnu.org, Paul Smith <psmith@gnu.org>
Subject: bug#15917: 24.3.50; manual: mention keys reserved for users
Date: Thu, 29 Oct 2020 11:28:56 -0700 (PDT)	[thread overview]
Message-ID: <ac4fd6e5-f511-4b37-8bbe-71a05bd84f9f@default> (raw)
In-Reply-To: <CADwFkmkevFnH68gyksx-cFOZC_RwufzeG38ikO_oSk0C0_w-RA@mail.gmail.com>

> >> How about "should not conflict"?  Otherwise, please propose an
> >> alternative.
> >
> > Better, yes.  But that could mean that we expect that,
> > most of the time, they won't (automatically).
> 
> I don't understand the second sentence.  Could you please elaborate?

"Should" has at least two meanings: (1) you should
do something (like must but less strong) and (2)
something probably will happen.

#2 says that we expect that something will likely
happen, but it doesn't say who makes it happen.
It's passive.  There's no telling someone that
you want them to do something.  It's just saying
that something will likely happen (somehow).

My suggestion is that we not allow such a reading.
Remove such ambiguity.

> > Active voice here removes such ambiguity, I think.
> >
> >   Key sequences that consist of @kbd{C-c} followed by a
> >   letter are reserved for users.  Please do not write
> >   code to be used by others that binds these keys.
> 
> Such advice is already in the elisp manual.  The user manual should
> rather advice users which keys are reserved for their use in their Init
> file.  So I don't think writing about "code to be used for others" is
> suitable here.

Sorry, I thought this was for the Elisp manual, node
`Coding Conventions'.

If this is for the user manual, and it's only a message
for users for their own use of keys, and not also users
who provide default key bindings for others (e.g. in
code they write), then my suggestion is to remove any
such text, beyond saying that these keys are reserved
for personal use (not just "users").

If you want to add (for some reason) that users can at
least expect that code Emacs distributes won't bind
such keys, that's OK too.





  reply	other threads:[~2020-10-29 18:28 UTC|newest]

Thread overview: 26+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2013-11-18  3:36 bug#15917: 24.3.50; manual: mention keys reserved for users Michael Heerdegen
2013-11-18  4:36 ` Drew Adams
2013-11-18  7:16   ` Josh
2013-11-18  9:16     ` Andreas Röhler
2020-10-28  7:39 ` Stefan Kangas
2020-10-28  8:05   ` Lars Ingebrigtsen
2020-10-29 10:07     ` Michael Heerdegen
2020-10-29 15:22       ` Stefan Kangas
2020-10-29 15:33         ` Stefan Kangas
2020-10-30 11:47           ` Lars Ingebrigtsen
2020-10-30 11:51             ` Eli Zaretskii
2020-10-30 11:55               ` Lars Ingebrigtsen
2020-10-30 12:09                 ` Stefan Kangas
2020-11-01 11:52                   ` Lars Ingebrigtsen
2020-10-29 16:59         ` Drew Adams
2020-10-29 17:22           ` Stefan Kangas
2020-10-29 17:58             ` Drew Adams
2020-10-29 18:15               ` Stefan Kangas
2020-10-29 18:28                 ` Drew Adams [this message]
2020-10-30  1:16                   ` Stefan Kangas
2020-10-30 19:29                     ` Drew Adams
2020-10-30 20:15                       ` Drew Adams
2020-10-30 20:20                         ` Eli Zaretskii
     [not found] <<87wqk6e5zm.fsf@web.de>
     [not found] ` <<CADwFkmnHdfS5ff6-b-yLsoGW_6o979YD6b=X_BxGo_-Y1wDaBQ@mail.gmail.com>
     [not found]   ` <<87v9euwzbe.fsf@gnus.org>
     [not found]     ` <<87blglmjlc.fsf@web.de>
     [not found]       ` <<CADwFkmmy1o0b0w3iwofZQF=MuiCy8tR8K2O+q-oRsKP3=6tyOg@mail.gmail.com>
     [not found]         ` <<54a1c039-6929-4e4d-ac9b-e7e5daf37c68@default>
     [not found]           ` <<CADwFkm=ddjsV1U+Teixfdzayhh=+y4i=ybCP=OgJpuajjWcHRw@mail.gmail.com>
     [not found]             ` <<62b06d46-5371-4df7-a3c5-b53f84e728ef@default>
     [not found]               ` <<CADwFkmkevFnH68gyksx-cFOZC_RwufzeG38ikO_oSk0C0_w-RA@mail.gmail.com>
     [not found]                 ` <<ac4fd6e5-f511-4b37-8bbe-71a05bd84f9f@default>
     [not found]                   ` <<CADwFkm=9vHHoBP31hZLRddbKmWbxiF93RSom5cmxo2xo5CDuKw@mail.gmail.com>
     [not found]                     ` <<ab6c8b7a-18cb-4562-a079-6d2ecf61c970@default>
     [not found]                       ` <<897aec19-fa31-4ee8-80b4-8241ce3710c6@default>
     [not found]                         ` <<837dr7a2kk.fsf@gnu.org>
2020-10-30 20:50                           ` Drew Adams
2020-10-30 21:03                             ` Eli Zaretskii
     [not found] <<<87wqk6e5zm.fsf@web.de>
     [not found] ` <<<CADwFkmnHdfS5ff6-b-yLsoGW_6o979YD6b=X_BxGo_-Y1wDaBQ@mail.gmail.com>
     [not found]   ` <<<87v9euwzbe.fsf@gnus.org>
     [not found]     ` <<<87blglmjlc.fsf@web.de>
     [not found]       ` <<<CADwFkmmy1o0b0w3iwofZQF=MuiCy8tR8K2O+q-oRsKP3=6tyOg@mail.gmail.com>
     [not found]         ` <<<54a1c039-6929-4e4d-ac9b-e7e5daf37c68@default>
     [not found]           ` <<<CADwFkm=ddjsV1U+Teixfdzayhh=+y4i=ybCP=OgJpuajjWcHRw@mail.gmail.com>
     [not found]             ` <<<62b06d46-5371-4df7-a3c5-b53f84e728ef@default>
     [not found]               ` <<<CADwFkmkevFnH68gyksx-cFOZC_RwufzeG38ikO_oSk0C0_w-RA@mail.gmail.com>
     [not found]                 ` <<<ac4fd6e5-f511-4b37-8bbe-71a05bd84f9f@default>
     [not found]                   ` <<<CADwFkm=9vHHoBP31hZLRddbKmWbxiF93RSom5cmxo2xo5CDuKw@mail.gmail.com>
     [not found]                     ` <<<ab6c8b7a-18cb-4562-a079-6d2ecf61c970@default>
     [not found]                       ` <<<897aec19-fa31-4ee8-80b4-8241ce3710c6@default>
     [not found]                         ` <<<837dr7a2kk.fsf@gnu.org>
     [not found]                           ` <<0b75f12c-9e1d-4f3f-b8c3-666ae3da6eb0@default>
     [not found]                             ` <<83zh438lzp.fsf@gnu.org>
2020-10-30 21:24                               ` 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=ac4fd6e5-f511-4b37-8bbe-71a05bd84f9f@default \
    --to=drew.adams@oracle.com \
    --cc=15917@debbugs.gnu.org \
    --cc=larsi@gnus.org \
    --cc=michael_heerdegen@web.de \
    --cc=psmith@gnu.org \
    --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 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.