Great idea!
I agree with selecta on 2.1.
To have examples and comments would be the most valuable part IMHO.
Documentation can be found today, even if it is spread around. But the
big difference would be if people could contribute with examples and
comments close to the documentation. That would m
> 2) integrate the above with a small web2py app that turns web2py
> docstrings into wiki pages. When users edit the wiki, the docstrings
> get updated, and I get a patch.
I proposed something like this earlier, so definitely agree.
http://groups.google.com/group/web2py/browse_thread/thread/231fe
The wiki would only be a way to make it easy for people to contribute.
I agree we need guidelines. page would be into parts (proposed edit
to the actual docstrings, annotations, comments). Changes to actual
docstrings would still need to go though the approval process.
Please share with us any th
I still think documenting the source code is the first step, then from
that we can build a wiki/faq/walkthrough off of it. But gluon/* needs
to be documented thoroughly before we do anything else.
We should instead be discussing a method/style of documenting gluon,
and then putting resources towar
On 05/02/2010 18:52, mdipierro wrote:
I am not sure if this does exactly what I mean (can you actually edit
and version docstrings and put them back in code?).
I don't know, but as Sphinx gets doc from the doc strings I would assume so.
Anyway, it would
be nice it somebody where to set this up
I can't comment technically on the idea of converting docstring to
wiki pages, although it sounds good. The problem with doc that I think
needs solving, however, is that of not being able to easily find items
in the doc. The v2 doc index is missing a ton of links -- really
important thinks like onv
I am not sure if this does exactly what I mean (can you actually edit
and version docstrings and put them back in code?). Anyway, it would
be nice it somebody where to set this up as an example for web2py.
On Feb 5, 11:32 am, "Werner F. Bruhin" wrote:
> On 05/02/2010 17:11, mdipierro wrote:
>
> >
On 05/02/2010 17:11, mdipierro wrote:
I got a private email from David and we have an idea:
1) organize a wiki with the same table of content as the book. Each
page will have an errata and a a faq. It will include some parts of
the book (when possible) and link the scribd book chapters when not
1) ok, i got the book, but 2 resources are better then one, people
explain differently so it will help to have a second source
2.0) love the idea :) exactly my thought ,
also i would split the docstring into multiple sections:
a) (short) description,
b) explanations of input and output variabl
> > 2) integrate the above with a small web2py app that turns web2py
> > docstrings into wiki pages. When users edit the wiki, the docstrings
> > get updated, and I get a patch.
>
> Interesting thought. I'm slightly skeptical (about editing docstrings outside
> the context of the source code itsel
10 matches
Mail list logo
