Hacker News new | ask | show | jobs
by honza 5690 days ago
I disagree. It doesn't look very well-organized. Python's docs are much cleaner.
2 comments

I feel like pythons docs are hard to use, its difficult to just look up a method quickly also the search feature never seems to be very accurate for me. I will give the python docs credit when it comes to supplying good examples though.
Once I figured out where to find the built-in functions, I haven't had a problem finding things since.

Docs > Library Reference > Built-In Functions (browser search for function)

I appreciate that they include all of the built-in functions in the same root directory as the remaining batteries-included modules.

The only wonky one for me now is the documentation for formatting strings, since it's documented in the "strings" module, but it's not dependent on the strings module.

Python's docs lack a place for comments, which is a shame.
It would just turn into a place where nobs ask questions, and you really want that done in the proper place. And you also have the moderator overhead.
The classic example of where this actually works well is in the PHP docs. Yes, you get idiots, but you also get good, real-world examples of a wider variety than the original documentation authors would have been able to produce. It's about the only thing I missed when I jumped from PHP to Python.

I think the Django Book's approach to this is really good as well, where the moderator overhead is implicitly taken on by the documentation authors. That works for them because they treat the document as a project in itself, rather than as a by-product.

Your bug is my feature.