GNU bug report logs - #53810
29.0.50; Incorrect docstring for ietf-drums-get-comment

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 53810 in the body.
You can then email your comments to 53810 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Bob Rogers <rogers <at> rgrjr.com>
To: bug-gnu-emacs <at> gnu.org
Subject: 29.0.50; Incorrect docstring for ietf-drums-get-comment
Date: Sat, 05 Feb 2022 18:51:45 -0500

In GNU Emacs 29.0.50 (build 2, x86_64-pc-linux-gnu, GTK+ Version 3.24.20, cairo version 1.16.0)
 of 2022-02-02 built on orion
Repository revision: ed13b0d0f427df333f8e1f9a24015c354da4c62f
Repository branch: rgr-ietf-drums-date
Windowing system distributor 'The X.Org Foundation', version 11.0.12003000
System Description: openSUSE Leap 15.3

   In master as of d34dd869d2, doing

	(ietf-drums-get-comment "random (comment) (string)")

returns "string", whereas the docstring says it returns the content of
the first comment.  The documentation for both ietf-drums-get-comment
and mail-header-get-comment say "last"; perusing the code (only
ietf-drums-get-comment is actually called) also shows that the last one
is what callers expect.

					-- Bob Rogers
					   http://www.rgrjr.com/

From d1c9098ddfe0a913f8c20606347e334ca06dd9d3 Mon Sep 17 00:00:00 2001
From: Bob Rogers <rogers <at> rgrjr.com>
Date: Sat, 5 Feb 2022 18:27:58 -0500
Subject: [PATCH] ; Correct the ietf-drums-get-comment docstring

* lisp/mail/ietf-drums.el (ietf-drums-get-comment):  We really return
  the last comment.
---
 lisp/mail/ietf-drums.el | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/lisp/mail/ietf-drums.el b/lisp/mail/ietf-drums.el
index 952707226f..fd9cb6abb7 100644
--- a/lisp/mail/ietf-drums.el
+++ b/lisp/mail/ietf-drums.el
@@ -150,7 +150,7 @@ ietf-drums-remove-whitespace
       (buffer-string))))
 
 (defun ietf-drums-get-comment (string)
-  "Return the first comment in STRING."
+  "Return the last comment in STRING."
   (with-temp-buffer
     (ietf-drums-init string)
     (let (result c)
-- 
2.34.1

Message #8 received at 53810 <at> debbugs.gnu.org (full text, mbox):

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: Bob Rogers <rogers <at> rgrjr.com>
Cc: 53810 <at> debbugs.gnu.org
Subject: Re: bug#53810: 29.0.50; Incorrect docstring for ietf-drums-get-comment
Date: Sun, 06 Feb 2022 01:08:09 +0100

Bob Rogers <rogers <at> rgrjr.com> writes:

> * lisp/mail/ietf-drums.el (ietf-drums-get-comment):  We really return
>   the last comment.

Thanks; pushed to emacs-28.

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no

Previous Next

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