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

RE: [PATCH] [DOCFIX] Fix ambiguous comments for svn_string_isempty()

From: Madan U S <madan_at_collab.net>
Date: 2006-03-10 06:31:46 CET

> -----Original Message-----
> From: Julian Foad [mailto:julianfoad@btopenworld.com]
> Sent: Thu 3/9/2006 7:12 PM
> To: Madan U S
> Cc: dev@subversion.tigris.org
> Subject: Re: [PATCH] [DOCFIX] Fix ambiguous comments for svn_string_isempty()
>
> Madan U S wrote:
> > [[[
> > Remove ambiguity in wc/workarea/subversion/include/svn_string.h
> Thanks for the suggestion, but that change is not necessary because "true"
> already means "non-zero" in C.

Agree on this point.

> (I much prefer "true" over "non-zero" or "@c TRUE", as truth values are so
> commonly used that there should be no need to distract the reader by
> emphasising at every point the particular implementation used for it.)

I think the docs are *also* (not to mention primarily) meant for first time 'see'ers of the code.
When I saw it first, and the next function comment said 'return @c TRUE' I was beginning to get confused.
Not that am gonna get stuck here again... somebody else might...

Just my two cents worth.

Regards,
Madan.

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org

Received on Fri Mar 10 06:35:00 2006

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