This is a nice start: AMK's Journal: Annotatable Python docs a move towards allowing the community to annotate and therefore help improve them.
I have jumped in and added something on String methods as a quick test. I wonder how much the standards used for the documentation has an effect. The php docs do look better (although they are not very deeply structured and there is far more variety of documentation in python). The php manual is in docbook, the python is not:
The markup used for the Python documentation is based on LATEX and requires a significant set of macros written specifically for documenting Python.The same page talks about python docs moving towards xml, I wonder what the current state of that is?
I would be very happy to see something that made it easier to write/patch and provided a little more modern looking output. Also it would be good to see more translations of the documentation.
I have generally found the python documentation good in content, but the prettier phpdocs seem to get it a better reputation for quality. I guess that more volunteers are needed. Hopefully Andrew's work here will help that happen.

Comments