Gavin Baumanis wrote:
> Hi Everyone,
>
> As Edmund goes through the header files and finds things in the
> comments that he doesn't understand - there is always a nice succinct
> reply from "someone" that clears up his understanding of the comment
> in question.
>
> Would it not be appropriate to change the documentation to be the
> provided succinct response, so that it might be clear(er) for all who
> visit the code next time around?
It definitely would; though, might it 'ruin' its appeal to
'hard core' devs? Reading the doc strings does help me
understand the code; but, only to a certain point. Sometimes
I just find the documentation overwhelming (possibly because
of my lack of a strong C background). As an anecdote,
I was surprised to see something like :
svn_wc_get_prop_diffs(apr_array_header_t **propchanges..
A pointer to a pointer to propchanges which is of the type
apr_array_header_t, right? Needless to say, I've got a long
ways to fully understand the code.
Btw, as a suggestion, I think 'understanding SVN' should
also be a requirement in order to be a dev on subversion.
It's unwritten, sure and possibly darn obvious; but, I didn't
think it was.
Anyway, thanks for the help in understanding the code,
well, at least the headers.
Edmund
------------------------------------------------------
http://subversion.tigris.org/ds/viewMessage.do?dsForumId=462&dsMessageId=1825079
Received on 2009-04-20 15:45:41 CEST