bug#70163: 29.3; hexl-mode incorrect docstring

[Thierry Volpiatto <thievol@posteo.net>]

[-- Attachment #1: Type: text/plain, Size: 955 bytes --]

Andreas Schwab <schwab@linux-m68k.org> writes:

> On Apr 03 2024, Eli Zaretskii wrote:
>
>>> From: Thierry Volpiatto <thievol@posteo.net>
>>> Date: Wed, 03 Apr 2024 15:02:52 +0000
>>> 
>>> 
>>> Hexl-mode docstring specify "\<hexl-mode-map>" in its first line, this
>>> to specify some keybinding related to this map at end, as a result the
>>> documentation command returns a three line string, the first line beeing
>>> a blank line until hexl.el is loaded.  I think docstrings generally
>>> should not have this specification in their first line.
>>> 
>>>     (defun hexl-mode (&optional arg)
>>>       "\\<hexl-mode-map>A mode for editing binary files in hex dump format.
>>>       [...] 
>>>       Most cursor movement bindings are the same: use \\[hexl-backward-char],
>>>       [...]
>>
>> What do you suggest to do instead?
>
> Customary is to put it directly before the (first) keymap reference.

Exactly.

-- 
Thierry

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 686 bytes --]