From: Jim Blandy <jimb@codesourcery.com>
To: Eli Zaretskii <eliz@gnu.org>
Cc: Mark Kettenis <mark.kettenis@xs4all.nl>,
deuling@de.ibm.com, pedro_alves@portugalmail.pt,
gdb-patches@sourceware.org
Subject: Re: [Patch]: Little Cleanup
Date: Mon, 05 Mar 2007 22:01:00 -0000 [thread overview]
Message-ID: <m3odn7gxjl.fsf@codesourcery.com> (raw)
In-Reply-To: <utzwzmlk7.fsf@gnu.org> (Eli Zaretskii's message of "Mon, 05 Mar 2007 23:23:36 +0200")
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.
next prev parent reply other threads:[~2007-03-05 22:01 UTC|newest]
Thread overview: 18+ messages / expand[flat|nested] mbox.gz Atom feed top
2007-03-02 7:04 Markus Deuling
2007-03-03 9:08 ` Pedro Alves
2007-03-03 10:29 ` Eli Zaretskii
2007-03-05 5:59 ` Markus Deuling
2007-03-05 21:04 ` Eli Zaretskii
2007-03-05 21:23 ` Mark Kettenis
2007-03-05 21:23 ` Eli Zaretskii
2007-03-05 22:01 ` Jim Blandy [this message]
2007-03-06 4:22 ` Eli Zaretskii
2007-03-06 19:53 ` Joel Brobecker
2007-03-06 20:40 ` Michael Snyder
2007-03-06 21:03 ` Eli Zaretskii
2007-03-06 22:10 ` Ulrich Weigand
2007-03-07 7:36 ` Markus Deuling
2007-03-07 12:15 ` Daniel Jacobowitz
2007-03-07 16:34 ` Eli Zaretskii
2007-03-09 4:48 ` Markus Deuling
2007-03-09 16:21 ` Ulrich Weigand
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=m3odn7gxjl.fsf@codesourcery.com \
--to=jimb@codesourcery.com \
--cc=deuling@de.ibm.com \
--cc=eliz@gnu.org \
--cc=gdb-patches@sourceware.org \
--cc=mark.kettenis@xs4all.nl \
--cc=pedro_alves@portugalmail.pt \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox