mirror/emacs
1
0
Fork 0
mirror of https://git.savannah.gnu.org/git/emacs.git synced 2024-11-30 08:09:04 +00:00
Code Issues Releases Activity

Better docstring and parameter name for seq-find

Browse Source 
* lisp/emacs-lisp/seq.el (seq-find): Improve the docstring and rename
the parameter `sentinel' to `default'.

* doc/lispref/sequences.texi (Sequence Functions): Update the
  documentation for `seq-find' accordingly.
This commit is contained in:
Nicolas Petton 2015-09-13 16:18:24 +02:00
parent e2f0dd2f49
commit 0a893f0cfa
2 changed files with 10 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
doc/lispref/sequences.texi
View File

@ -578,15 +578,14 @@ value is the value returned by @var{predicate}.
@end example
@end defun
@defun seq-find predicate sequence &optional sentinel
@defun seq-find predicate sequence &optional default
This function returns the first element for which @var{predicate}
returns non-@code{nil} in @var{sequence}. If no element matches
@var{predicate}, @var{sentinel} is returned if non-@code{nil},
@code{nil} otherwise.
@var{predicate}, @var{default} is returned.
Note that this function has an ambiguity if the found element is
@code{nil}, and if no @var{sentinel} is specified, as it cannot be
known if an element was found or not.
identical to @var{default}, as it cannot be known if an element was
found or not.
@example
@group

12
lisp/emacs-lisp/seq.el
View File

@ -270,18 +270,18 @@ If so, return the non-nil value returned by PRED."
(throw 'seq--break result))))
nil))
(cl-defgeneric seq-find (pred seq &optional sentinel)
(cl-defgeneric seq-find (pred seq &optional default)
"Return the first element for which (PRED element) is non-nil in SEQ.
If no element is found, return SENTINEL or nil.
If no element is found, return DEFAULT.
Note that `seq-find' has an ambiguity if the found element is nil
and if no SENTINEL is specified, as it cannot be known if an
element was found or not."
Note that `seq-find' has an ambiguity if the found element is
identical to DEFAULT, as it cannot be known if an element was
found or not."
(catch 'seq--break
(seq-doseq (elt seq)
(when (funcall pred elt)
(throw 'seq--break elt)))
sentinel))
default))
(cl-defgeneric seq-count (pred seq)
"Return the number of elements for which (PRED element) is non-nil in SEQ."