From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Eli Zaretskii Newsgroups: gmane.emacs.bugs Subject: bug#70163: 29.3; hexl-mode incorrect docstring Date: Wed, 03 Apr 2024 21:14:48 +0300 Message-ID: <86le5u8g9z.fsf@gnu.org> References: <871q7mlc9v.fsf@posteo.net> <86plv68myf.fsf@gnu.org> <878r1ucsgq.fsf@igel.home> <87a5mal6nv.fsf@posteo.net> Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="26898"; mail-complaints-to="usenet@ciao.gmane.io" Cc: 70163@debbugs.gnu.org, schwab@linux-m68k.org, monnier@iro.umontreal.ca To: Thierry Volpiatto Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Wed Apr 03 20:16:34 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 1rs5A1-0006oR-S1 for geb-bug-gnu-emacs@m.gmane-mx.org; Wed, 03 Apr 2024 20:16:33 +0200 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1rs59Y-00007B-Ph; Wed, 03 Apr 2024 14:16:04 -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 1rs59S-00006R-Ni for bug-gnu-emacs@gnu.org; Wed, 03 Apr 2024 14:15:58 -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 1rs59S-0005af-BD for bug-gnu-emacs@gnu.org; Wed, 03 Apr 2024 14:15:58 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1rs59W-0005xE-P5 for bug-gnu-emacs@gnu.org; Wed, 03 Apr 2024 14:16:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Eli Zaretskii Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Wed, 03 Apr 2024 18:16:02 +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.171216812222594 (code B ref 70163); Wed, 03 Apr 2024 18:16:02 +0000 Original-Received: (at 70163) by debbugs.gnu.org; 3 Apr 2024 18:15:22 +0000 Original-Received: from localhost ([127.0.0.1]:59549 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1rs58r-0005sK-Nf for submit@debbugs.gnu.org; Wed, 03 Apr 2024 14:15:22 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:48160) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1rs58m-0005rD-Sh for 70163@debbugs.gnu.org; Wed, 03 Apr 2024 14:15:18 -0400 Original-Received: from fencepost.gnu.org ([2001:470:142:3::e]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1rs58Y-0005Eq-I6; Wed, 03 Apr 2024 14:15:02 -0400 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnu.org; s=fencepost-gnu-org; h=References:Subject:In-Reply-To:To:From:Date: mime-version; bh=Lu1/9unAFEEP42HiU0Rdip5JLaO0IzKglGugZg0dkqc=; b=CDYY5Zk33Ydx PJp6Hs9LUbRJIMHjrZ5T7Rkg65yyZN/A6teqPKOFwjHqGxQy2ReL/NRoXpLBQSVA4XYpRX+9ponCT ibXYa/vuX4avVBexwBlY5j5flpmyU3/ocUVuYqmqMnJCJQEIcbTE1n1ZEBuxFjfEuhTLYfNbGyTRQ NvquwoswFmGKxeAdtWxTig9wgqjgNoD5WjXo23GCGKjzs+/jwf5hrBOKOTzlsxUQro1a8bLGmDtSl e+BxhB/qw2eNwgwOfEV/KU6Vg+l0rvdv+1d8PTmkaY5DkgEJd7hhcpyJviDWeTU5brS40oYa+94F9 C4OuR0XaiihdqqhjvyUt8w==; In-Reply-To: <87a5mal6nv.fsf@posteo.net> (message from Thierry Volpiatto on Wed, 03 Apr 2024 17:04:04 +0000) 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:282586 Archived-At: > From: Thierry Volpiatto > Cc: Eli Zaretskii , Stefan Monnier > , 70163@debbugs.gnu.org > Date: Wed, 03 Apr 2024 17:04:04 +0000 > > > Andreas Schwab writes: > > > 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. > > Exactly. So we don't want an empty line at the beginning of a doc string, but are okay with having it farther into the doc string? Any particular reason why? Or what am I missing?