]> git.eshelyaron.com Git - emacs.git/commitdiff
; Improve documentation of 'match-buffers'
authorEli Zaretskii <eliz@gnu.org>
Mon, 10 Apr 2023 09:30:23 +0000 (12:30 +0300)
committerEli Zaretskii <eliz@gnu.org>
Mon, 10 Apr 2023 09:30:23 +0000 (12:30 +0300)
* doc/lispref/buffers.texi (Buffer List):
* lisp/subr.el (match-buffers): Fix documentation of
'buffer-match-p' and 'match-buffers'.

doc/lispref/buffers.texi
lisp/subr.el

index b56006e5aa99e09d2a129dafe502cca934f84112..86c47ae731028ccdbcdf7555678f78038ded96ca 100644 (file)
@@ -959,9 +959,9 @@ infinite recursion.
 
 @defun buffer-match-p condition buffer-or-name &optional arg
 This function checks if a buffer designated by @code{buffer-or-name}
-satisfies a @code{condition}.  Optional third argument @var{arg} is
-passed to the predicate function in @var{condition}.  A condition can
-be one of the following:
+satisfies the specified @code{condition}.  Optional third argument
+@var{arg} is passed to the predicate function in @var{condition}.  A
+valid @var{condition} can be one of the following:
 @itemize @bullet{}
 @item
 A string, interpreted as a regular expression.  The buffer
@@ -990,21 +990,23 @@ Satisfied if @emph{all} the conditions in @var{conds} satisfy
 Satisfied if the buffer's major mode derives from @var{expr}.
 @item major-mode
 Satisfied if the buffer's major mode is equal to @var{expr}.  Prefer
-using @code{derived-mode} instead when both can work.
+using @code{derived-mode} instead, when both can work.
 @end table
 @item t
 Satisfied by any buffer.  A convenient alternative to @code{""} (empty
-string), @code{(and)} (empty conjunction) or @code{always}.
+string) or @code{(and)} (empty conjunction).
 @end itemize
 @end defun
 
 @defun match-buffers condition &optional buffer-list arg
-This function returns a list of all buffers that satisfy a
-@code{condition}, as defined for @code{buffer-match-p}.  By default
-all buffers are considered, but this can be restricted via the second
-optional @code{buffer-list} argument.  Optional third argument
-@var{arg} will be used by @var{condition} in the same way as
-@code{buffer-match-p} does.
+This function returns a list of all buffers that satisfy the
+@code{condition}.  If no buffers match, the function returns
+@code{nil}.  The argument @var{condition} is as defined in
+@code{buffer-match-p} above.  By default, all the buffers are
+considered, but this can be restricted via the optional argument
+@code{buffer-list}, which should be a list of buffers to consider.
+Optional third argument @var{arg} will be passed to @var{condition} in
+the same way as @code{buffer-match-p} does.
 @end defun
 
 @node Creating Buffers
index 46dcd97d8291e4a80c1f5fb39d5f68984c3c3290..d4428aef765d4bca47700adbb41fbeda83a3ce81 100644 (file)
@@ -7128,12 +7128,13 @@ CONDITION is either:
     (funcall match (list condition))))
 
 (defun match-buffers (condition &optional buffers arg)
-  "Return a list of buffers that match CONDITION.
-See `buffer-match-p' for details on CONDITION.  By default all
-buffers are checked, this can be restricted by passing an
-optional argument BUFFERS, set to a list of buffers to check.
-ARG is passed to `buffer-match', for predicate conditions in
-CONDITION."
+  "Return a list of buffers that match CONDITION, or nil if none match.
+See `buffer-match-p' for various supported CONDITIONs.
+By default all buffers are checked, but the optional
+argument BUFFERS can restrict that: its value should be
+an explicit list of buffers to check.
+Optional argument ARG is passed to `buffer-match-p', for
+predicate conditions in CONDITION."
   (let (bufs)
     (dolist (buf (or buffers (buffer-list)))
       (when (buffer-match-p condition (get-buffer buf) arg)