bug#19461: 25.0.50; doc of `display-buffer-*' functions that take ALIST arg

[Lars Ingebrigtsen]

martin rudalics <rudalics@gmx.at> writes:

>> I think the docstrings must tell that.  Because the names suggest the
>> opposite.  Something like "this function is for internal use only
>
> Readers might then ask why it does not use the "--" notation.

And the answer is the same as with all the other internal functions that
don't -- historical reasons.

> "This is an action function for buffer display.  It should be called
> only by 'display-buffer' or a function directly or indirectly called
> by the latter."
>
> Or with a reference to the Elisp manual:
>
> "This is an action function for buffer display, see Info node `(elisp)
> Buffer Display Action Functions'.  It should be called only by
> 'display-buffer' or a function directly or indirectly called by the
> latter."

Sounds good to me.

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no