[svn.haxx.se] · SVN Dev · SVN Users · SVN Org · TSVN Dev · TSVN Users · Subclipse Dev · Subclipse Users · this month's index

TRUE/true/FALSE/false/NULL/null in doc strings [was: svn commit: r34018 - in ...]

From: Julian Foad <julianfoad_at_btopenworld.com>
Date: Wed, 05 Nov 2008 12:31:32 +0000

On Wed, 2008-11-05 at 05:23 +0100, Neels J. Hofmeyr wrote:
> > I've updated the doc strings in r34026/r34028/r34029.
> Thanks! I'd like to change one to say TRUE and FALSE in upper case, because
> that's what is used with svn_boolean_t. Is it standard practice in the doc
> strings to write true and false in lower case?

We haven't standardized. I prefer lower case because I don't see a need
to make them stand out visually, the reader doesn't need to follow a
cross-reference to their definitions, and the API user doesn't need to
use the same defined constants that we use internally. However, the
majority of us seem to prefer upper case, usually with an "@c" Doxygen
tag. I like consistency but ... whatever!

- Julian

To unsubscribe, e-mail: dev-unsubscribe_at_subversion.tigris.org
For additional commands, e-mail: dev-help_at_subversion.tigris.org
Received on 2008-11-05 13:31:53 CET

This is an archived mail posted to the Subversion Dev mailing list.

This site is subject to the Apache Privacy Policy and the Apache Public Forum Archive Policy.