[Ksummit-discuss] [CORE-TOPIC] Documentation

Peter Hüwe PeterHuewe at gmx.de
Mon Jul 13 19:20:32 UTC 2015


Am Montag, 13. Juli 2015, 11:47:23 schrieb Alexey Dobriyan:
> On Mon, Jul 13, 2015 at 1:38 AM, Peter Hüwe <PeterHuewe at gmx.de> wrote:
> > as we talked about recruiting in the other thread I realized that one
> > thing that might reduce the entrance barrier a bit (apart from tooling
> > and flow) would be proper documentation.
> 
> Newbies should not write documentation because they, by definition,
> have little knowledge of the code. It will lead to many, many useless
> and redundant comments like below whose only purpose is stealing
> vertical whitespace:

While I agree with your 'stupid documentation is stupid' argument, I tend to 
somewhat disagree about that newbies should not write documentation.

By newbies I do not mean someone new to programming - that of course makes no 
sense - but why shouldn't a experienced c-programmer who is currently figuring 
out how the kernel works not document stuff along the way?

I think that's much better than fixing whitespaces and long lines.

Peter


More information about the Ksummit-discuss mailing list