31 Jul
2013
31 Jul
'13
12:01 a.m.
Results:
5 +1
1 +0
0 -1
The suggestion of repealing a rule leads people to think of the worst
possible outcome, hence the immortality of even the most ridiculous
legal prohibitions. Despite the fact that a single committer could
have killed this vote, we unanimously agreed to do something a little
crazy and for that I am proud.
In a year I'll review this change and report back on it's effectiveness.
Hold me to it.
Thanks,
Caleb
On 07/26/2013 04:47 PM, Caleb James DeLisle wrote:
Hi,
To promote contribution and encourage code brevity, I would like to remove
the rule that we fail the build over a missing javadoc on a non-public
field.
It's important to understand, this is *not* about encouraging developers
to skimp on documentation!
There are obvious cases such as 'logger' where the role of the field is
blatantly clear and forced documentation is at best useless and at worst
counterproductive because it creates an information overload for the code
reader and hides the comments which the author really wanted to be seen.
+1 for dropping this rule
Thanks,
Caleb
_______________________________________________
devs mailing list
devs(a)xwiki.org
http://lists.xwiki.org/mailman/listinfo/devs