[Grok-dev] a Grok 1.0 release plan

[Brandon Craig Rhodes]

Martijn Faassen <faassen at startifact.com> writes:

> I think we should consider calling the next release of Grok: Grok 1.0.

I note that most of the Grok code that I have seen violates PEP-8 by
being almost entirely devoid of docstrings (not to mention comments).  I
have been thinking about going through and adding some simple docstrings
to make it easier for both newcomers to the code, and us old-timers with
bad memories.

Is this something I should try doing before 1.0?  What is the Zope
approach toward docstrings - are they frowned upon?  From the almost
entire lack of them in Zope code, I wondered if they were considered a
bad idea, and if the code was supposed to "just be clear enough" that no
docstrings were needed to define what things do.

But, if it were up to me, I'd like the code to have docstrings, and I'm
willing to add them - but can put my efforts elsewhere if everyone else
thinks that's a waste. ;-)

-- 
Brandon Craig Rhodes   brandon at rhodesmill.org   http://rhodesmill.org/brandon