-----BEGIN PGP SIGNED MESSAGE----- Hash: SHA1 Rinku wrote: > >>> *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.
lol - +1 for code docs (although I believe that was more tongue and cheek than anything) and a definite +1 to scary. I don't think anyone was knocking the importance of docs - just the when, by whom, at what level, and of what importance are they in relation to the code and a release. As with everything else, opinions vary and so does mileage. > > Rahul > > --------------------------------------------------------------------- > To unsubscribe, e-mail: [EMAIL PROTECTED] > For additional commands, e-mail: [EMAIL PROTECTED] > > > -----BEGIN PGP SIGNATURE----- Version: GnuPG v1.2.5 (MingW32) iD8DBQFEDQkAaCoPKRow/gARAjKLAKCV+OnF1ztUbbTEpf+FdR2Kzxc5ZwCfad4+ vhDvIGE7dBggWmwYYmZIsrs= =Pv8S -----END PGP SIGNATURE----- --------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
