I agree the epydocs are not very useful, which makes the manual crucial right now. (http://www.web2py.com/examples/static/epydoc/index.html)
The current wiki has a number of recipes/explanations but it is never going to systematically cover the entire API. It is basically a new AlterEgo. So how about importing the current API into the wiki (or a new app as selecta suggests) to make it easier to fill out the documentation. These updates could eventually be fed back into the docstrings. On Feb 4, 8:44 am, selecta <gr...@delarue-berlin.de> wrote: > I agree that an on-line book is a bad idea, I never liked to read text > for humans while programming, it just distracts me, (even the nice > book from Massimo) > BUT > if we had something like the php documentation it would be awesome > The documentation (epydoc) is already quite good but the interface is > dreadful > If you look athttp://de.php.net/manual/en/function.preg-replace.php > this is really good > short description what is does (got it) > longer description of what the parameters mean (we would need some > improvement here but if this was wiki like I would be glad to help, > not that I would read this text) > most important part: > Examples (docstring test - highiliting missing in epydoc!!!) > and even more examples from users (plugin comments, with some minor > improvements like source highliting) > ...also nice related functions and a hierarchy on the left > > If you start a documentation project please try to copy the php online > documentation, if you do this as an open source web2py app I would be > willing to help programming and filling it with examples ... > > what do you think ... most of the work would be to write a web2py app, > some get payed for that, so it is justified because parts can be > reused .... > > On Feb 3, 9:58 pm, mdipierro <mdipie...@cs.depaul.edu> wrote: > > > Denes is right. > > > On Feb 3, 1:59 pm, DenesL <denes1...@yahoo.ca> wrote: > > > > AFAIK Massimo does not oppose but actually encourages the creation of > > > more documentation in any form. > > > > On Feb 3, 2:48 pm, villas <villa...@gmail.com> wrote: > > > > > Well to be fair, it didn't sound like Massimo was in favour of an > > > > online book earlier in this same thread. That was why I thought there > > > > was a case to be made. > > > > > You are right of course about raising the next question: who is going > > > > to do it? But in my mind, there isn't any point in trying to cross > > > > that bridge if influential people like Massimo wouldn't wish to go > > > > anyway. > > > > > Where there's a will, there may be a way; but without that the > > > > status quo shall remain. Not that the status quo is sooo bad! (apart > > > > from the pop group, I mean) :) -- You received this message because you are subscribed to the Google Groups "web2py-users" group. To post to this group, send email to web...@googlegroups.com. To unsubscribe from this group, send email to web2py+unsubscr...@googlegroups.com. For more options, visit this group at http://groups.google.com/group/web2py?hl=en.
