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

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

[Tino Calancha]

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

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

[Robert Cochran]

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

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

[Nicolas Petton]

[-- Attachment #1: Type: text/plain, Size: 185 bytes --]

Robert Cochran <robert-emacs@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

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 512 bytes --]