[Grok-dev] grok reference - what needs to be documented and what not

[Sebastian Ware]

As a newbie user I would rather only see the documentation of the  
functions and classes that I actually use. For me, less is more. If I  
wanted to dig deeper, I would probably examine the code.

Regards Sebastian

29 maj 2007 kl. 09.39 skrev Jan-Wijbrand Kolman:

> Hi,
>
>
> I have started on the grok reference, getting familiar with the latex
> syntax, and the reference's content structure.
>
> First question: Do you expect *all* functions and classes etc. to be
> documented, or "only" the ones that a developer *with* grok gets in
> contact with?
>
> As an example: I started with the url() function in util.py. This is,
> as far as I can see, the only function in this module that a regular
> developer will need from this module. The fact that it is imported in
> __init__ illustrates this.
>
> Would that actually be a usefull guide: "The reference will document
> everything that is imported in __init__?"
>
>
> Next steps will be to (finally) settle checkin rights and to have the
> reference-in-progress show up at some URL for "testing".
>
>
> kind regards,
> jw
>
> -- 
> Jan-Wijbrand Kolman
> _______________________________________________
> Grok-dev mailing list
> Grok-dev at zope.org
> http://mail.zope.org/mailman/listinfo/grok-dev