Home Original page

Python doc experiment

Batista, Facundo FBatista at uniFON.com.ar
Thu Sep 9 10:43:48 EDT 2004 
[A.M. Kuchling]

#- As a half-hour hack, I took a copy of the Python docs, stuck 
#- them in a
#- frameset, and added some JavaScript that displays a 
#- corresponding Wiki page
#- in another frame.  Feel free to play with 
#- http://pydoc.amk.ca/frame.html;
#- please record problems on the Wiki page at
#- http://pydoc.amk.ca/w/KnownProblems .

Interesting experiment. I certainly appreciate your work.

And I think here is the place to comment this:

I find *very* useful the way that MySQL handles this. It shows the standard
text for the item (the same text that the PDF) and lets the user to add
comments (not to edit the other text). You can see one example at
http://dev.mysql.com/doc/mysql/en/Insert_speed.html.

This way, user experience can be added to each item. More, this can be
useful to the responsible of that doc to get important feedback, and maybe
in later versions he/she can get this feedback *into* the std docs, or fix
bugs in the docs, etc.

.	Facundo
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/python-list/attachments/20040909/dc9d1bc3/attachment.html>
More information about the Python-list mailing list