From: Thierry Volpiatto <thievol@posteo.net>
To: Eli Zaretskii <eliz@gnu.org>
Cc: 70163@debbugs.gnu.org, Stefan Monnier <monnier@iro.umontreal.ca>
Subject: bug#70163: 29.3; hexl-mode incorrect docstring
Date: Wed, 03 Apr 2024 17:04:58 +0000 [thread overview]
Message-ID: <874jcil6md.fsf@posteo.net> (raw)
In-Reply-To: <86plv68myf.fsf@gnu.org> (Eli Zaretskii's message of "Wed, 03 Apr 2024 18:50:32 +0300")
[-- Attachment #1: Type: text/plain, Size: 2086 bytes --]
Eli Zaretskii <eliz@gnu.org> writes:
>> 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?
Something like this?
diff --git a/lisp/hexl.el b/lisp/hexl.el
index 1288cf4d7fb..a10c1b35536 100644
--- a/lisp/hexl.el
+++ b/lisp/hexl.el
@@ -256,7 +256,7 @@ as that will override any bit grouping options set here."
;;;###autoload
(defun hexl-mode (&optional arg)
- "\\<hexl-mode-map>A mode for editing binary files in hex dump format.
+ "A mode for editing binary files in hex dump format.
This is not an ordinary major mode; it alters some aspects
of the current mode's behavior, but not all; also, you can exit
Hexl mode and return to the previous mode using `hexl-mode-exit'.
@@ -295,7 +295,7 @@ A sample format:
000000c0: 7265 6769 6f6e 2e0a region..
Movement is as simple as movement in a normal Emacs text buffer.
-Most cursor movement bindings are the same: use \\[hexl-backward-char], \\[hexl-forward-char], \\[hexl-next-line], and \\[hexl-previous-line]
+Most cursor movement bindings are the same: use \\<hexl-mode-map>\\[hexl-backward-char], \\[hexl-forward-char], \\[hexl-next-line], and \\[hexl-previous-line]
to move the cursor left, right, down, and up.
Advanced cursor movement commands (ala \\[hexl-beginning-of-line], \\[hexl-end-of-line], \\[hexl-beginning-of-buffer], and \\[hexl-end-of-buffer]) are
--
Thierry
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 686 bytes --]
prev parent reply other threads:[~2024-04-03 17:04 UTC|newest]
Thread overview: 34+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-04-03 15:02 bug#70163: 29.3; hexl-mode incorrect docstring Thierry Volpiatto
2024-04-03 15:50 ` Eli Zaretskii
2024-04-03 16:37 ` Andreas Schwab
2024-04-03 17:04 ` Thierry Volpiatto
2024-04-03 18:14 ` Eli Zaretskii
2024-04-04 5:47 ` Thierry Volpiatto
2024-04-04 12:18 ` Eli Zaretskii
2024-04-04 12:45 ` Andreas Schwab
2024-04-04 13:07 ` Eli Zaretskii
2024-04-04 13:20 ` Andreas Schwab
2024-04-04 12:54 ` Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors
2024-04-04 13:16 ` Andreas Schwab
2024-04-04 13:23 ` Eli Zaretskii
2024-04-04 13:37 ` Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors
2024-04-04 18:41 ` Thierry Volpiatto
2024-04-05 5:46 ` Eli Zaretskii
2024-04-05 6:29 ` Thierry Volpiatto
2024-04-06 10:46 ` Eli Zaretskii
2024-04-06 11:27 ` Thierry Volpiatto
2024-04-06 12:52 ` Ihor Radchenko
2024-04-06 14:05 ` Andreas Schwab
2024-04-06 14:15 ` Eli Zaretskii
2024-04-06 15:05 ` Andreas Schwab
2024-04-06 15:27 ` Eli Zaretskii
2024-04-06 15:49 ` Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors
2024-04-06 16:16 ` Eli Zaretskii
2024-04-06 20:01 ` Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors
2024-04-06 20:21 ` Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors
2024-04-07 5:29 ` Eli Zaretskii
2024-04-07 14:48 ` Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors
2024-04-07 14:57 ` Eli Zaretskii
2024-04-07 16:07 ` Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors
2024-04-07 16:11 ` Eli Zaretskii
2024-04-03 17:04 ` Thierry Volpiatto [this message]
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=874jcil6md.fsf@posteo.net \
--to=thievol@posteo.net \
--cc=70163@debbugs.gnu.org \
--cc=eliz@gnu.org \
--cc=monnier@iro.umontreal.ca \
/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).