Re: [Patch]: Little Cleanup

Jim Blandy
2007-03-05T22:01:29Z

Eli Zaretskii <eliz@gnu.org> writes:
>> Date: Mon, 5 Mar 2007 22:19:20 +0100 (CET)
>> From: Mark Kettenis <mark.kettenis@xs4all.nl>
>> CC: deuling@de.ibm.com, pedro_alves@portugalmail.pt,
>> gdb-patches@sourceware.org
>> >
>> > I thought we agreed about adding a comment here, something like:
>> >
>> > /* insert_breakpoints returns non-zero if it fails to insert the
>> > breakpoints. */
>>
>> Adding this sort of comments at all call sites of such functions is
>> really silly.
>
> I don't see anything silly about making the code clearer.

I'm confident Mark believes clarifying code is not silly. I think
Mark disagrees that the comment you requested is, in fact, a
clarification.

I tend to agree with Mark, here. The place to document the meaning of
a function's return value is at the function, not at each of its call
sites.