GNU bug report logs - #70163
29.3; hexl-mode incorrect docstring

Previous Next

Full log

View this message in rfc822 format

From: Thierry Volpiatto <thievol <at> posteo.net>
To: Andreas Schwab <schwab <at> linux-m68k.org>
Cc: 70163 <at> debbugs.gnu.org, Eli Zaretskii <eliz <at> gnu.org>, Stefan Monnier <monnier <at> iro.umontreal.ca>
Subject: bug#70163: 29.3; hexl-mode incorrect docstring
Date: Wed, 03 Apr 2024 17:04:04 +0000

[Message part 1 (text/plain, inline)]

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

> On Apr 03 2024, Eli Zaretskii wrote:
>
>>> From: Thierry Volpiatto <thievol <at> 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

[signature.asc (application/pgp-signature, inline)]

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.