GNU bug report logs - #24182
25.1.50; map--dispatch: doc string mentions a non existent argument

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 24182 in the body.
You can then email your comments to 24182 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: Tino Calancha <tino.calancha <at> gmail.com>
To: bug-gnu-emacs <at> gnu.org
Subject: 25.1.50; map--dispatch: doc string mentions a non existent
 argument
Date: Mon, 8 Aug 2016 19:38:13 +0900 (JST)

The last line of the doc string is as follows:

"Return RESULT if non-nil or the result of evaluation of the form."

There is any 'result' argument; if no error, the macro always
returns the result of the evaluation of the form.


In GNU Emacs 25.1.50 (x86_64-pc-linux-gnu, GTK+ Version 3.20.6)
 of 2016-08-07
Repository revision: b593ea1f9b7068c03fe6527a3cb6d5e1b2cd9736

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

From: Robert Cochran <robert-emacs <at> cochranmail.com>
To: Tino Calancha <tino.calancha <at> gmail.com>
Cc: 24182 <at> debbugs.gnu.org
Subject: Re: bug#24182: 25.1.50;
 map--dispatch: doc string mentions a non existent argument
Date: Fri, 19 Aug 2016 15:11:24 -0700

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

Here's my attempt to fix the docstring. Comments welcome.

-----

[0001-lisp-emacs-lisp-map.el-map-dispatch-Fix-docstring.patch (text/x-patch, inline)]

From 0c5bc38f170719cde0d25df392465e4acc935896 Mon Sep 17 00:00:00 2001
From: Robert Cochran <robert-git <at> cochranmail.com>
Date: Fri, 19 Aug 2016 14:53:07 -0700
Subject: [PATCH] * lisp/emacs-lisp/map.el (map--dispatch): Fix docstring

The docstring referenced a non-existant parameter, as well as a
parameter that has been renamed since the docstring was written. Fix
both errors, fixing (Bug#24182).
---
 lisp/emacs-lisp/map.el | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/lisp/emacs-lisp/map.el b/lisp/emacs-lisp/map.el
index 98a8871..0a0f64a 100644
--- a/lisp/emacs-lisp/map.el
+++ b/lisp/emacs-lisp/map.el
@@ -79,14 +79,14 @@ map-let
 
 (eval-when-compile
   (defmacro map--dispatch (map-var &rest args)
-    "Evaluate one of the forms specified by ARGS based on the type of MAP.
+    "Evaluate one of the forms specified by ARGS based on the type of MAP-VAR.
 
 The following keyword types are meaningful: `:list',
 `:hash-table' and `:array'.
 
-An error is thrown if MAP is neither a list, hash-table nor array.
+An error is thrown if MAP-VAR is neither a list, hash-table nor array.
 
-Return RESULT if non-nil or the result of evaluation of the form."
+Returns the result of evaluating the form associated with MAP-VAR's type."
     (declare (debug t) (indent 1))
     `(cond ((listp ,map-var) ,(plist-get args :list))
            ((hash-table-p ,map-var) ,(plist-get args :hash-table))
-- 
2.7.4

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

-----

HTH,
-- 
~Robert Cochran

GPG Fingerprint - E778 2DD4 FEA6 6A68 6F26  AD2D E5C3 EB36 4886 8871

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

From: Nicolas Petton <nicolas <at> petton.fr>
To: Robert Cochran <robert-emacs <at> cochranmail.com>,
 Tino Calancha <tino.calancha <at> gmail.com>
Cc: 24182 <at> debbugs.gnu.org, 24182-done <at> debbugs.gnu.org
Subject: Re: bug#24182: 25.1.50;
 map--dispatch: doc string mentions a non existent argument
Date: Sat, 20 Aug 2016 00:42:45 +0200

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

Robert Cochran <robert-emacs <at> cochranmail.com> writes:

> Here's my attempt to fix the docstring. Comments welcome.

Thanks, it looks good, I applied your patch to master.

Cheers,
Nico

[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.