Annotatable Python docs -- now a reality !!!

Stephen Ferg steve at ferg.org
Mon Sep 13 08:45:31 EDT 2004


Andrew Kuchling has just posted this (see below) on his blog.  

I'm confident that people will use this, if they know it is available.
So now is the time to get the word out.  This is something everyone in
the Python community should know about it.

==================================================
from http://www.amk.ca/diary/archives/cat_python.html#003336

September 09, 2004

Annotatable Python docs

In recent months several posters on comp.lang.python have suggested
that Python would benefit from making it possible for people to
comment on the documentation, an approach similar to the PHP docs.
However, no one has ever actually tried to set up such a system.

In a half-hour hack, I wrapped a frameset around the Python 2.3.4
documentation, added some JavaScript that updates another frame to
display a Wiki page for the documentation page you're viewing, and
simplified the Wiki pages as much as I easily could.

The resulting annotatable documentation is at
http://pydoc.amk.ca/frame.html. Please go and add any commentary,
links, or other material you wish. Let's see if commenting on the docs
is a feature people will use, or if it's a feature people just say
they'll use.



More information about the Python-list mailing list