huntercross wrote: > the webpy.org/docs > are completely incomprehensible to the beginning user. i can attest to > that having to slog my way through it with whats up there. the best > documentation is actual working code i think, so the examples i've > added to reference are there because i found them in old posts in the > google group and various places around the web. Its a matter of > organization for me and would make it easy to have integrated things > later to have a unique URI for each webpy object. > > i don't think the cookbook approach is best when you really just need > a language reference to look up a particular line that you are having > trouble with. Each and every object of webpy should be documented. > Alot of times you may need to know exactly what something returns, or > a better way to modify the returned data and that is clearly not > spelled out in the current /docs page. > > Also, the docs page is way too long. Since it is a wiki i am afraid to > edit that and make my little changes because it might effect the > entire docs page. Moving each into its own page makes it a lot less > intimidating to add a little bit of information and i think encourages > participation. > hc > > > On Feb 20, 11:27 pm, huntercross <[EMAIL PROTECTED]> wrote: >> yes, something more in line with PHP's function reference, where the >> arguments aren't always easy to remember.
How about using epydoc or similar to create an API reference exactly the way you want it automatically? It recycles the docstrings and is always up to date (as long as the docstrings are and the docs are refreshed with every new release). b^4 --~--~---------~--~----~------------~-------~--~----~ You received this message because you are subscribed to the Google Groups "web.py" 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/webpy?hl=en -~----------~----~----~----~------~----~------~--~---
