[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: No return value in doc string
From: |
Dieter Wilhelm |
Subject: |
Re: No return value in doc string |
Date: |
Sat, 29 Apr 2006 12:01:35 +0200 |
User-agent: |
Gnus/5.11 (Gnus v5.11) Emacs/22.0.50 (gnu/linux) |
Stefan Monnier <monnier@iro.umontreal.ca> writes:
>
> 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.
Thank you, this is a point I didn't realise.
> 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.
But has the disadvantage that the uninitiated and insecure (my
example) may suspect a documentation flaw.
>> Should I report this as bugs or is this a bit over the top?
> Your call,
Eli Z. convinced me already not to waste anybodies time with it.
--
Best wishes
Dieter Wilhelm