From: Eli Zaretskii <eliz@gnu.org>
Date: Wed, 19 Oct 2016 18:10:31 +0000 (+0300)
Subject: Fix documentation of 'alist-get'
X-Git-Tag: emacs-25.1.90~102
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=8988327d548db7b69f30ea15496ccb0726fa4502;p=emacs.git

Fix documentation of 'alist-get'

* doc/lispref/lists.texi (Association Lists): Fix the signature of
'alist-get'.  Fix the markup, the wording, and the punctuation in
the description. (Bug#24740)
---

diff --git a/doc/lispref/lists.texi b/doc/lispref/lists.texi
index e7a739f88f3..dc4075dbab4 100644
--- a/doc/lispref/lists.texi
+++ b/doc/lispref/lists.texi
@@ -1556,15 +1556,15 @@ keys may not be symbols:
 @end smallexample
 @end defun
 
-@defun alist-get key value &optional default remove
+@defun alist-get key alist &optional default remove
 This function is like @code{assq}, but instead of returning the entire
-association for @var{key}, @code{(@var{key} . @var{value})}, it
-returns just the @var{value}.  If @var{key} is not found in
-@var{alist} it returns @var{default}.
+association for @var{key} in @var{alist},
+@w{@code{(@var{key} . @var{value})}}, it returns just the @var{value}.
+If @var{key} is not found in @var{alist}, it returns @var{default}.
 
 This is a generalized variable (@pxref{Generalized Variables}) that
 can be used to change a value with @code{setf}.  When using it to set
-a value, optional argument @var{remove} non-nil means to remove
+a value, optional argument @var{remove} non-@code{nil} means to remove
 @var{key} from @var{alist} if the new value is @code{eql} to @var{default}.
 @end defun