mirror/emacs
1
0
Fork 0
mirror of https://git.savannah.gnu.org/git/emacs.git synced 2024-11-26 07:33:47 +00:00
Code Issues Releases Activity

Fix documentation of 'alist-get'

Browse Source 
* 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)
This commit is contained in:
Eli Zaretskii 2016-10-19 21:10:31 +03:00
parent b6998eab37
commit 8988327d54
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/lispref/lists.texi
View File

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