]> code.delx.au - gnu-emacs/commitdiff
Doc fixed for next-error-buffer-p
authorLars Ingebrigtsen <larsi@gnus.org>
Sat, 30 Apr 2016 00:03:24 +0000 (02:03 +0200)
committerLars Ingebrigtsen <larsi@gnus.org>
Sat, 30 Apr 2016 00:03:24 +0000 (02:03 +0200)
* lisp/simple.el (next-error-buffer-p): Clarify doc string
(bug#18202).

lisp/simple.el

index cb4ddc6c3e2f7e751c2e2773f6f5e2d3d192f403..849cbd6863ae34d12f0849d6d880c9608c3b16c1 100644 (file)
@@ -145,18 +145,18 @@ nil means use goto-char using the second argument position.")
                               &optional avoid-current
                               extra-test-inclusive
                               extra-test-exclusive)
-  "Test if BUFFER is a `next-error' capable buffer.
-
-If AVOID-CURRENT is non-nil, treat the current buffer
-as an absolute last resort only.
-
-The function EXTRA-TEST-INCLUSIVE, if non-nil, is called in each buffer
-that normally would not qualify.  If it returns t, the buffer
-in question is treated as usable.
-
-The function EXTRA-TEST-EXCLUSIVE, if non-nil, is called in each buffer
-that would normally be considered usable.  If it returns nil,
-that buffer is rejected."
+  "Return non-nil if BUFFER is a `next-error' capable buffer.
+If AVOID-CURRENT is non-nil, and BUFFER is the current buffer,
+return nil.
+
+The function EXTRA-TEST-INCLUSIVE, if non-nil, is called if
+BUFFER would not normally qualify.  If it returns non-nil, BUFFER
+is considered `next-error' capable, anyway, and the function
+returns non-nil.
+
+The function EXTRA-TEST-EXCLUSIVE, if non-nil, is called if the
+buffer would normally qualify.  If it returns nil, BUFFER is
+rejected, and the function returns nil."
   (and (buffer-name buffer)            ;First make sure it's live.
        (not (and avoid-current (eq buffer (current-buffer))))
        (with-current-buffer buffer