[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: doc string of compilation-next-error
From: |
Stefan Monnier |
Subject: |
Re: doc string of compilation-next-error |
Date: |
Mon, 23 Apr 2007 00:52:55 -0400 |
User-agent: |
Gnus/5.11 (Gnus v5.11) Emacs/22.0.97 (gnu/linux) |
> 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