views:

57

answers:

2

I'm about to dive into the source code for the cgi.py module again because the MiniFieldStorage class is mentioned in the documentation, but not actually documented. It occurred to me that I have done this so many times that maybe I could write documentation for it. If I did, how should I submit it?

+4  A: 

There's a page regarding Documentation Development on the official web site which looks like a good starting point. It appears as though you simply add to the issue tracker and attach a patch in the normal way.

In particular, it points to Documenting Python, which appears to be a rather exhaustive guide on formatting documentation; style guidelines, etc.

Rob
+1  A: 

I would suggest posting an issue to the documentation bug tracker, including the patch of course. This is mentioned in the section on contributing on the site.

If that doesn't work, or seems slow, I guess you can dig up developers to bug directly, but that can also be considered impolite, so read up first on the proper etiquette.

unwind