Massimo, could you provide a list with reference to the files that need docs?
any way or idea, to separate, distribute the tasks, manage the
versions and make the moderation of docstrings.

I can help with that, a little every day, I reserve some hours of my
day for this task, it would be interesting even to me, so I learn more
about the framework, and it helps me to formulate training material
for my Python-Web2py classes, and to write the articles to the blog
and IT-Magazine that I mentioned to you by mail.

I agree with you, and I believe in future the documentation generated
in docstring could be shifted toward an easy reference guide.

Furthermore, I advocate using a help forum (PyForum), instead of
concentrating everything in the group,I like most of the style of
organizing a forum, I'm pretty used to seek help in ubuntuforuns and
several others, IMHO Forum has much more effective role in providing
help than a list like this, forum is easy to search, best indexed by
search engines, best with usability, navigation etc.

How can we start with docstrings?



2010/7/13 mdipierro <[email protected]>:
> That is the problem.
>
> for people who seriously want to help. Setting up another wiki is not
> help. Instead, adopt a web2py file, add docstrings to all functions.
>
> On 13 Lug, 16:38, ra3don <[email protected]> wrote:
>> Yeah i noticed its a little hard to comprehend sometime if you have no
>> idea whats going on. Some entries don't have descriptions at all, just
>> leaves you scratching your head.
>>
>> On Jul 12, 10:25 pm, weheh <[email protected]> wrote:
>>
>> > @MDP: No reason for GAE in particular other than it's free initially
>> > and because it's a showcase. Any server is good, as long as the url is
>> > something like web2py.com/reference. There is no performance issue
>> > with the current doc.
>>
>> > @ra3don: Epydocs have very little verbiage and is indecipherable to
>> > the average user, IMHO.



-- 

http://rochacbruno.com.br

Reply via email to