From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Andreas Schwab Newsgroups: gmane.emacs.bugs Subject: bug#70163: 29.3; hexl-mode incorrect docstring Date: Wed, 03 Apr 2024 18:37:57 +0200 Message-ID: <878r1ucsgq.fsf@igel.home> References: <871q7mlc9v.fsf@posteo.net> <86plv68myf.fsf@gnu.org> Mime-Version: 1.0 Content-Type: text/plain Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="35050"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Gnus/5.13 (Gnus v5.13) Cc: Thierry Volpiatto , 70163@debbugs.gnu.org, Stefan Monnier To: Eli Zaretskii Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Wed Apr 03 18:39:39 2024 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1rs3eE-0008si-L2 for geb-bug-gnu-emacs@m.gmane-mx.org; Wed, 03 Apr 2024 18:39:38 +0200 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1rs3dq-0006PI-Bc; Wed, 03 Apr 2024 12:39:14 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1rs3de-0006Oo-Jz for bug-gnu-emacs@gnu.org; Wed, 03 Apr 2024 12:39:03 -0400 Original-Received: from debbugs.gnu.org ([2001:470:142:5::43]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1rs3dd-0000fE-0Y for bug-gnu-emacs@gnu.org; Wed, 03 Apr 2024 12:39:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1rs3dh-0002xj-Cl for bug-gnu-emacs@gnu.org; Wed, 03 Apr 2024 12:39:05 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Andreas Schwab Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Wed, 03 Apr 2024 16:39:05 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 70163 X-GNU-PR-Package: emacs Original-Received: via spool by 70163-submit@debbugs.gnu.org id=B70163.171216228911132 (code B ref 70163); Wed, 03 Apr 2024 16:39:05 +0000 Original-Received: (at 70163) by debbugs.gnu.org; 3 Apr 2024 16:38:09 +0000 Original-Received: from localhost ([127.0.0.1]:59397 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1rs3cn-0002tU-1h for submit@debbugs.gnu.org; Wed, 03 Apr 2024 12:38:09 -0400 Original-Received: from mail-out.m-online.net ([212.18.0.10]:60488) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1rs3ck-0002sv-9m for 70163@debbugs.gnu.org; Wed, 03 Apr 2024 12:38:07 -0400 Original-Received: from frontend01.mail.m-online.net (unknown [192.168.8.182]) by mail-out.m-online.net (Postfix) with ESMTP id 4V8r5g248Mz1sG8b; Wed, 3 Apr 2024 18:37:59 +0200 (CEST) Original-Received: from localhost (dynscan1.mnet-online.de [192.168.6.68]) by mail.m-online.net (Postfix) with ESMTP id 4V8r5g0Ypsz1qqlS; Wed, 3 Apr 2024 18:37:59 +0200 (CEST) X-Virus-Scanned: amavis at mnet-online.de Original-Received: from mail.mnet-online.de ([192.168.8.182]) by localhost (dynscan1.mail.m-online.net [192.168.6.68]) (amavis, port 10024) with ESMTP id LH-Uya_IuVny; Wed, 3 Apr 2024 18:37:58 +0200 (CEST) X-Auth-Info: RV/F8/4D8xFCNfgMefOssX7toj8HFhfYRxK4b5oxSKfUn62TUod1VFy880rEk3mR Original-Received: from igel.home (aftr-62-216-202-233.dynamic.mnet-online.de [62.216.202.233]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by mail.mnet-online.de (Postfix) with ESMTPSA; Wed, 3 Apr 2024 18:37:58 +0200 (CEST) Original-Received: by igel.home (Postfix, from userid 1000) id F17202C1A72; Wed, 3 Apr 2024 18:37:57 +0200 (CEST) In-Reply-To: <86plv68myf.fsf@gnu.org> (Eli Zaretskii's message of "Wed, 03 Apr 2024 18:50:32 +0300") X-Yow: Who wants some OYSTERS with SEN-SEN an' COOL WHIP? X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Original-Sender: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Xref: news.gmane.io gmane.emacs.bugs:282575 Archived-At: On Apr 03 2024, Eli Zaretskii wrote: >> From: Thierry Volpiatto >> Date: Wed, 03 Apr 2024 15:02:52 +0000 >> >> >> Hexl-mode docstring specify "\" 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) >> "\\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. -- Andreas Schwab, schwab@linux-m68k.org GPG Key fingerprint = 7578 EB47 D4E5 4D69 2510 2552 DF73 E780 A9DA AEC1 "And now for something completely different."