* bug#24182: 25.1.50; map--dispatch: doc string mentions a non existent argument
2016-08-08 10:38 bug#24182: 25.1.50; map--dispatch: doc string mentions a non existent argument Tino Calancha
@ 2016-08-19 22:11 ` Robert Cochran
2016-08-19 22:42 ` Nicolas Petton
0 siblings, 1 reply; 3+ messages in thread
From: Robert Cochran @ 2016-08-19 22:11 UTC (permalink / raw)
To: Tino Calancha; +Cc: 24182
[-- Attachment #1: Type: text/plain, Size: 66 bytes --]
Here's my attempt to fix the docstring. Comments welcome.
-----
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: Patch to fix (map--dispatch) docstring --]
[-- Type: text/x-patch, Size: 1434 bytes --]
From 0c5bc38f170719cde0d25df392465e4acc935896 Mon Sep 17 00:00:00 2001
From: Robert Cochran <robert-git@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
[-- Attachment #3: Type: text/plain, Size: 102 bytes --]
-----
HTH,
--
~Robert Cochran
GPG Fingerprint - E778 2DD4 FEA6 6A68 6F26 AD2D E5C3 EB36 4886 8871
^ permalink raw reply related [flat|nested] 3+ messages in thread