[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
bug#18092: 24.4.50; doc string of `define-prefix-command'
From: |
Lars Ingebrigtsen |
Subject: |
bug#18092: 24.4.50; doc string of `define-prefix-command' |
Date: |
Sat, 30 Apr 2016 00:51:12 +0200 |
User-agent: |
Gnus/5.13 (Gnus v5.13) Emacs/25.1.50 (gnu/linux) |
Drew Adams <drew.adams@oracle.com> writes:
> Define COMMAND as a prefix command. COMMAND should be a symbol.
> A new sparse keymap is stored as COMMAND's function definition and its value.
> If a second optional argument MAPVAR is given, the map is stored as
> its value instead of as COMMAND's value; but COMMAND is still defined
> as a function.
> The third optional argument NAME, if given, supplies a menu name
> string for the map. This is required to use the keymap as a menu.
> This function returns COMMAND.
>
> 1. It is not at all clear what the occurrence of "its" in the 4th
> sentence ("If a second...") refers to. And this part of the doc
> string should explicitly say what MAPVAR is: a symbol that is used as
> a variable - it is given the map as value.
Yes, that's quite unclear. I've now clarified.
> 2. The second line of the doc string is too long - should not be more
> than 70 chars long.
And filled.
--
(domestic pets only, the antidote for overdose, milk.)
bloggy blog: http://lars.ingebrigtsen.no
- bug#18092: 24.4.50; doc string of `define-prefix-command',
Lars Ingebrigtsen <=