diff options
| author | Eli Zaretskii | 2016-10-19 21:10:31 +0300 |
|---|---|---|
| committer | Eli Zaretskii | 2016-10-19 21:10:31 +0300 |
| commit | 8988327d548db7b69f30ea15496ccb0726fa4502 (patch) | |
| tree | 7a966faf755f7173af470ec9874bddcefa37a77d | |
| parent | b6998eab37962357fda49a6a3b013c73228af187 (diff) | |
| download | emacs-8988327d548db7b69f30ea15496ccb0726fa4502.tar.gz emacs-8988327d548db7b69f30ea15496ccb0726fa4502.zip | |
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)
| -rw-r--r-- | doc/lispref/lists.texi | 10 |
1 files changed, 5 insertions, 5 deletions
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: | |||
| 1556 | @end smallexample | 1556 | @end smallexample |
| 1557 | @end defun | 1557 | @end defun |
| 1558 | 1558 | ||
| 1559 | @defun alist-get key value &optional default remove | 1559 | @defun alist-get key alist &optional default remove |
| 1560 | This function is like @code{assq}, but instead of returning the entire | 1560 | This function is like @code{assq}, but instead of returning the entire |
| 1561 | association for @var{key}, @code{(@var{key} . @var{value})}, it | 1561 | association for @var{key} in @var{alist}, |
| 1562 | returns just the @var{value}. If @var{key} is not found in | 1562 | @w{@code{(@var{key} . @var{value})}}, it returns just the @var{value}. |
| 1563 | @var{alist} it returns @var{default}. | 1563 | If @var{key} is not found in @var{alist}, it returns @var{default}. |
| 1564 | 1564 | ||
| 1565 | This is a generalized variable (@pxref{Generalized Variables}) that | 1565 | This is a generalized variable (@pxref{Generalized Variables}) that |
| 1566 | can be used to change a value with @code{setf}. When using it to set | 1566 | can be used to change a value with @code{setf}. When using it to set |
| 1567 | a value, optional argument @var{remove} non-nil means to remove | 1567 | a value, optional argument @var{remove} non-@code{nil} means to remove |
| 1568 | @var{key} from @var{alist} if the new value is @code{eql} to @var{default}. | 1568 | @var{key} from @var{alist} if the new value is @code{eql} to @var{default}. |
| 1569 | @end defun | 1569 | @end defun |
| 1570 | 1570 | ||