Re: doc string of compilation-next-error

[Stefan Monnier]

> Shouldn't the doc string mention what the return value is?  At least
> one use of the function in the Emacs source code makes use of this
> value:

>   (let* ((columns compilation-error-screen-columns) ; buffer's local value
>        (last 1)
>        (loc (compilation-next-error (or n 1) nil
>                                     (or compilation-current-error
>                                         compilation-messages-start
>                                         (point-min))))
>        (end-loc (nth 2 loc))
>        (marker (point-marker)))
>     ...)

This code is in compilation-next-error-function, so it's safe to say that
this is an internal use, in which case it may rely on
non-documented behaviors.
I.e. I don't see any need to document this return value, unless it seems it
might be useful for some non-internal code.


        Stefan