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 thoughts about guidelines for docstrings. On Feb 5, 1:01 pm, Thadeus Burgess <[email protected]> wrote: > 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 towards it. This will help by making web2py > much easier for contributors to actually contribute. Once there is > ample amounts of documentation in the source code, then we can begin > migrating things to the wiki using an automatic system. Even werkzeug > has very nice documentation that has two versions, one compiled from > the last developmental commit, and one from the last stable commit. > > I have an extremely strong opinion about the following. Source code > documentation should NOT be editable through a wiki. I do not like > this idea. It does not seem safe. I would only trust the source > documentation to those who contribute source code. > > -Thadeus > > On Fri, Feb 5, 2010 at 12:09 PM, Werner F. Bruhin <[email protected]> > wrote: > > > 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 as an example for web2py. > > > Maybe check with the author/student where he is with the project and explain > > what you would like to see. > > > Werner > > >> On Feb 5, 11:32 am, "Werner F. Bruhin"<[email protected]> 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 > >>>> possible. > > >>>> 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. > > >>>> What do people think? > > >>> What about reuse? > > >>> E.g.:http://tosh.pl/gminick/gsoc/sphinx/ > > >>> Werner > > > -- > > You received this message because you are subscribed to the Google Groups > > "web2py-users" 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. > > -- You received this message because you are subscribed to the Google Groups "web2py-users" 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.
