From: Joel Brobecker <brobecker@adacore.com>
To: Yao Qi <yao@codesourcery.com>
Cc: gdb-patches@sourceware.org
Subject: Re: FYI: My Coding Style cheat-sheet on the Wiki
Date: Thu, 06 Jan 2011 14:17:00 -0000 [thread overview]
Message-ID: <20110106141659.GD2351@adacore.com> (raw)
In-Reply-To: <4D25CA81.3040102@codesourcery.com>
> > /* The maximum number of tasks known to the Ada runtime */
> > static const int MAX_NUMBER_OF_KNOWN_TASKS = 1000;
>
> What is the expected/correct format of comment here? Isn't ended with
> period and two spaces? If we still follow the "period and two spaces"
> schema here, I'll update this wikipage and source code to reflect this.
(blush) Worst example I could have chosen... This is bad.
Yes, you are correct, a period and 2 spaces would be required.
It's not entirely obvious, since you can argue that the comment
is not a sentence. However, for something that long, either we
make it a real sentence, or we think of it as a sentence. Only
in the case of very short comment can we get away with no period
at the end of comment...
Thanks for catching this. I will fix the code...
--
Joel
prev parent reply other threads:[~2011-01-06 14:17 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2011-01-06 8:32 Joel Brobecker
2011-01-06 12:38 ` Hui Zhu
2011-01-06 13:58 ` Yao Qi
2011-01-06 14:17 ` Joel Brobecker [this message]
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=20110106141659.GD2351@adacore.com \
--to=brobecker@adacore.com \
--cc=gdb-patches@sourceware.org \
--cc=yao@codesourcery.com \
/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