emacs-devel
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: master c3ab8f1: Improve buffer-match-p documentation


From: Eli Zaretskii
Subject: Re: master c3ab8f1: Improve buffer-match-p documentation
Date: Sat, 16 Apr 2022 11:34:10 +0300

> diff --git a/doc/lispref/windows.texi b/doc/lispref/windows.texi
> index 43f222d..abc8ada 100644
> --- a/doc/lispref/windows.texi
> +++ b/doc/lispref/windows.texi
> @@ -2596,13 +2596,11 @@ Choosing Window
> 
>  @defopt display-buffer-alist
>  The value of this option is an alist mapping conditions to display
> -actions.  Each condition may be either a regular expression matching a
> -buffer name or a function that takes two arguments: a buffer name and
> -the @var{action} argument passed to @code{display-buffer}.  If either
> -the name of the buffer passed to @code{display-buffer} matches a
> -regular expression in this alist, or the function specified by a
> -condition returns non-@code{nil}, then @code{display-buffer} uses the
> -corresponding display action to display the buffer.
> +actions.  Each condition is passed to @code{buffer-match-p}, along
> +with the buffer name and the @var{action} argument passed to
> +@code{display-buffer}.  If it returns a non-nil value, then
> +@code{display-buffer} uses the corresponding display action to display
> +the buffer.

Since buffer-match-p is not documented in the manual, I think this
change is for the worse, as it leaves CONDITIONS undocumented.  Or am
I missing something?

In any case, referencing a function without an explicit
cross-reference is not a good style for the manual, unless the
function is described in the same node and prior to the reference.

Thanks.



reply via email to

[Prev in Thread] Current Thread [Next in Thread]