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

Previous Next

Full log

View this message in rfc822 format

From: Robert Cochran <robert-emacs <at> cochranmail.com>
To: Tino Calancha <tino.calancha <at> gmail.com>
Cc: 24182 <at> debbugs.gnu.org
Subject: 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

Previous Next

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