On Jan 19, 2:59 am, Anthony <abasta...@gmail.com> wrote: > These are great thoughts. One comment below... > > On Tuesday, January 18, 2011 7:21:05 PM UTC-5, cjrh wrote: > > documentation. Epydoc provides a space for writing module-level > > comments, and my gut feel is that the higher-level description of the > > source code itself should appear here. Perhaps a link from the book > > chapter to the Epydoc page for that module? >
> that may not always be as easy to gleen from module/class/function > docstrings. For example, Jonathan's "Installation and Deployment" section > refers to more than one module, so that kind of thing needs to be handled at > a higher level than just a module docstring. There was a malfunction on my link to the module-level documentation that I was referring to (curse you Frames): first go here: http://www.web2py.com/examples/static/epydoc/index.html And then click on web2py.gluon.dal on the left. You will see module- level documentation on the right, which is already prose-like and descriptive. This is what I was referring to as a suggested location for the "tour guide to the source code". > He also explains installation > and startup scripts, which are probably not covered in the API documentation > at all. That should definitely go into the book, no question.
