Quoth Avernus:

…but I constantly find myself wishing it was more like the PHP documentation in that related functions and methods are displayed in a sidebar.

I guess I’d just like to see something like the PHP documentation for Python. Whenever I do things in PHP, their web documentation (and their user comments) prove to be an incredibly useful resource. Maybe I could write up something similar during the upcoming semester.

Good point. I think one of PHP’s strong point has always been the quality of the documentation (function reference in particular) at PHP.net. It’s easy to use and highly informative. Additionally, the annotated version of the docs (with user comments) usually has the answer to just about any question I might have.

The state of the Python documentation is good… but there are definitely opportunities for improvement.

Side note: I should add that Python, unlike PHP, does have a detailed and strongly recommended style guide in the form of PEP8. That’s a Good Thing. I’ve been working on my first “real” application, and the guide has been a huge help for me.

This entry was posted on Saturday, January 7th, 2006 at 12:33 am and is filed under PHP, Python. You can follow any responses to this entry through the RSS 2.0 feed. You can leave a response, or trackback from your own site.