[Bf-committers] Code Documentation

Martin Poirier bf-committers@blender.org
Thu, 13 May 2004 11:04:55 -0700 (PDT)

I'm suggesting that the responsability of
documentation falls under the module owners. Whether
they do it themselves or not is irrelevant, their goal
would be to make sure that it is done. 

I know that this is putting a lot of weight on the
shoulders of the modules owners, especially since we
asked them to produce proper regression test files for
the next release, but who better than the owner should
know the code and be able to document it.

/me makes a note to talk about this during the sunday


--- Chris Burt <desoto@blender.spaceisbig.com> wrote:
> It also matters a great deal that the list of
> contributors to Blender's 
> source is growing. The documentation of the code may
> not have been an 
> issue when fewer people were working on it. But as
> more and more people 
> dare to look under the hood and start poking around,
> more and more 
> people will complain that its confusing. So should
> the responsibility 
> fall on those who created the code or those who are
> active in the 
> community to document? Is fine to complain that
> something needs to be 
> done, but all too often in the community people will
> work harder griping 
> than they will coding. If this becomes one of those
> situations, "The 
> code needs to be documented" and then you just sit
> and wait for someone 
> to do it, it won't happen.
> _______________________________________________
> Bf-committers mailing list
> Bf-committers@blender.org

Do you Yahoo!?
Yahoo! Movies - Buy advance tickets for 'Shrek 2'