What do you mean about doc/build/html/index.html? Where can I find it? Sorry for this stupid question.
When talking about doc in docstring, I would agree it is best option from a developer's point of view, because it might less possibly result in code-and-doc-out-of-sync. But for most general users (not developers), they might only pay attention to fancy html docs rather than docstring in source code. Of course we can shrink the gap by this workflow: 1. core developers maintains docstrings carefully, synchronize them with code change. 2. an easy way (sphinx?) to generate all doc into decent html, release them as built-in official documents 3. web2py users reads the documents, no need to dive into docstring in source code so much. (For example, I used python for years but never read comments (if any) in its source code. Do you?) Even for developers, there is still issue to be addressed. If more than one core developer (Massimo) will update the docstring, how do they collaborate with each other? I smell frequent source code conflict here. After all, svn etc. are not like a wiki. Only wiki is designed for many people to work on open documents. On May4, 11:27pm, Yarko Tymciurak <[email protected]> wrote: > Hi - > Can you now also add one more source: > > -- doc/build/html/index.html > > This is the preliminary documentation built in sphinx, courtesy of Tim > Michelson which Massimo just added (Thanks Tim!) > > Also - I ask that people take a good look at docstrings in the sources, and > - as you get answers to your questions on pieces, update the docstring (in > reStructuredText, of course). > > Over time, this should set a pattern for a standard documentation docstring > we use. (Usage, and example would be good). > --~--~---------~--~----~------------~-------~--~----~ You received this message because you are subscribed to the Google Groups "web2py Web Framework" group. To post to this group, send email to [email protected] To unsubscribe from this group, send email to [email protected] For more options, visit this group at http://groups.google.com/group/web2py?hl=en -~----------~----~----~----~------~----~------~--~---
