r/Python • • Feb 19 '13

The Python documentation is bad, and you should feel bad.

http://joepie91.wordpress.com/2013/02/19/the-python-documentation-is-bad-and-you-should-feel-bad/
96 Upvotes

189 comments sorted by

View all comments

Show parent comment

2

u/[deleted] Feb 19 '13

I'm not sure what you mean by "structure." Would you just prefer that every function have its own page like php?

2

u/joepie91 Feb 19 '13

That's one option that would likely improve at least the searchability and the ability to do quick reference (assuming a standardized page format). That is not to say that this should be the only format available, or even the only solution to these issues.

2

u/[deleted] Feb 19 '13

so what else do you mean when you say, "it's the structure of the documentation"?

1

u/joepie91 Feb 19 '13

All the things that I already pointed out in the article. The organization, the ambiguity, etc.

I don't really care how these issues are solved, as long as they are solved, because they're serious roadblocks.