*sigh* yeah... [been trying that approach - not w/ maven (yet) - and
met with limited success because of "that's documentation. we're here to
work on code" responses (or complete lack of response entirely) - hence
my ire over "have users just look at the code" opinions.]
Nah, I think that's a last resort. Because then we'd need to document
the code :)
This is possibly the best thing I've ever heard said about a wiki.
Taking knowledge from a wiki into documentation is great. Using a wiki
AS documentation is where my issue arises.
Documenting the code isn't a bad idea at all and can save *a lot* of
pain for users who can't find answers on the list or docs as well as for
contributors who want to work on patches.
IMHO and from my humble experience it doesn't take long to to put a
couple of lines of brief description of intent on methods and notes for
complex code segments - especially when your brain is taking a few
moments and running similar thought cycles and creating logical steps!
of course, documenting an existing non-doc'ed code base could be scary ;-)
+1 for code docs.
Rahul
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
