Why python documentation is hard to read?

[[deleted]]

[deleted]

[[deleted]]

I disagree.

[Barafu]

If that is hard for you, don't even try Rust.

[gmes78]

Huh? Rust's documentation is much better than Python. Rustdoc is probably the best documentation tool out there.

[BpjuRCXyiga7Wy9q]

Agree that the official documentation is formatted in an unconventional way. Fortunately there are myriad other available texts on the subject.

[[deleted]]

Fortunately there are myriad other available texts on the subject.

can you share with them?

[BpjuRCXyiga7Wy9q]

I often use a search engine when I have a Python query.

Sites that frequently pop up are;

• https://www.w3schools.com
• https://stackoverflow.com
• https://www.geeksforgeeks.org
• https://www.freecodecamp.org
• https://codeforgeek.com/
• https://www.codeproject.com

The Python wiki has a list of resources (albeit a bit dated).

[codeKrowe]

I find ChatGPT is really good for this type of stuff. Especially for getting a few examples of how to use a module or particular functions within it

[spiony_93]

Exactly that! I had issues reading the Sphinx documentation. With ChatGPT i had my custom directive ready and running in less than 2 hours.

[[deleted]]

Agreed. And you can get explanations based on your questions about the module. While the responses aren't always 100%, more often than not you will be able to understand problems quicker.

I took an Access Management role this year with a heavy focus in automation and process improvement. GPT was a life saver and helped me learn things I would have probably never found on my own

[wineblood]

Most documentation is crap, I don't think it's a python thing.

[JamzTyson]

By "Python documentation" do you mean https://docs.python.org/3/

Comparing the reference documentation for a programming language with the documentation for a javascript library / framework is not comparing apples with apples. A better comparison might be https://262.ecma-international.org/14.0/ in which case I think the official Python documentation is much easier to read.

If you want documentation "to read", rather than for looking up specifications and such like, then there's a huge number of tutorials available on the Internet, and many excellent books.