Python Documentation?
Gerhard Häring
gh at ghaering.de
Mon Sep 1 10:42:41 EDT 2003
Dan Thrue wrote:
> No i wont judge anything a failure in this community :) To say it
> shortly, the wiki doesnt actually fill my requirements.
I actually find the PHP approach of being able to attach user comments
to doc pages useful. I try to stay clear from PHP ;-), but I do use it
in the PostgreSQL interactive documentation:
Here's an example:
http://www.postgresql.org/docs/7.3/interactive/ddl-alter.html#AEN1984
I find it's a good way to add notes about what's not clear and what
information is wrong or lacking to the docs. Certainly an easier
approach than to file a bug report or a doc patch for the Python docs at
Sourceforge.
The PostgreSQL docs are created from SGML, while the Python docs are
created from a LaTeX subset, so I don't know if there's any solution
that could easily be set up for the Python documentation. I'd like to
see it implemented, though. [1]
-- Gerhard
[1] If nothing else, I could then add "does anybody actually directly
use this cra^wmodule?" to the page for ftplib <0.1 wink>
More information about the Python-list
mailing list