Re: No return value in doc string

[Stefan Monnier]

> Is there any policy for the documentation string of the return value?
> The Elisp programming guidelines just mention that the documentation
> string for functions should answer the question "What does this
> function do?".  So I'd consider leaving out the return value in a doc
> string of an interactive function a failure (please have a look at
> `next-line' `previous-line' and `make-frame').

When called interactively, a function's return value is simply ignored, so
if a function is expected to only be called interactively, there is no
reason to document the return value.

Also if the function makes no effort to return anything useful, it
might be better not to document what the return value happens to be.

> Should I report this as bugs or is this a bit over the top?

Your call,


        Stefan