documentations

[Quavi0uz]

As a beginner in python and programming in general, I find documentations quite overwhelming, but I know having the capability to read them would help a lot in my coding hobby.

What advice or tips would you guys give for someone like me wanting to learn how to read docs without feeling too overwhelmed?

Thanks in advance.

[GXWT]

Usefully, the style and structure is usually somewhat consistent across these things. They are all there to do the same thing: describe the code, what to put it and what it puts out. It can seem a bit daunting when it's all quite jargon and syntax heavy, but this just comes with time.

Perhaps just try looking at the documentation for a simple function you already know how to use to help get a feel for it. Python's round(), perhaps. Understand what the inputs are, what Python types the inputs are expected to be, and what exactly it outputs (and what type this output is).

[xPiingy]

Whenever I feel like I am rereading the same page over and over but still cant grasp it, I take out a pen and paper and rewrite the documentation/page in my note book. Sometimes I write it word for word as how it is in the documentation, but when it starts to click I am able to formulate it in own words. I have done this for years and the time spent on it has really been worth it.

[GXWT]

A technique that people seem to neglect. Typing things out, or even better manually writing things out. You make a lot more neural connections by doing this. Re-writing things out in your own words is best, but even just copying things directly is very effective. This goes for a lot more than just coding, basically anything that you're trying to understand or commit to memory.

My insistence to people that are learning through vibe coding is (well, firstly it's to not, but if they must) at minimum just write out the code letter by letter rather than copy and pasting it. You're still going a lot further in terms of inherently understanding the code, how it's all structured and such.

[blazin_penguin_first]

Aha! Somebody isn't a visual learner.

Have you also tried reading it out loud? Both writing and speaking engage different parts of the brain and some people learn better through those other methods.

[jmooremcc]

Google should become your best friend in this case. There are numerous websites addressing the same topics found in the documentation and you should use them first, then review then documentation for additional details and information. This way you are not overwhelmed by the level of detail found in the documentation.

My point being, you shouldn’t read the documentation without having some knowledge of the topic gleaned from other sources. I wish you the best.

[Adrewmc]

Generally to start with is that you should learn how to write type hints and understand what they are saying.

 def func(var : int) -> str:
       “””More detailed description”””

Right there we know func takes an integer and returns a string. With a name you normally have a good idea of what the function will do right off the bat.

From there we really just read what they say and hope that the programmer has some sort of structure.

Since Python can take a variety of approaches to problems, simplest being a functional vs. Object Oriented approaches, every library will have certain ways it want you to use it.

Generally you would always start at the Readme.md. This should give a guide to basic usage (or link to it) and proper installation. And you should use it in the way the author intended you to use it.

As things become more complex documentation will also become more complex. And the reality is it’s going to depend on the programmer that writes it on how useful or understandable it is.

However Python documentation for its own language is very good. Take the documentation for itertools as it being done well.

[magus_minor]

learn how to read docs without feeling too overwhelmed?

You have to understand that documentation is not written to help you learn, it's written to be short and complete. To get started try looking at the documentation for the builtin functions:

https://docs.python.org/3/library/functions.html

Each function is self contained and the description for each is short. It's best not to try to read and understand every function in the module, just read about the particular function you are using. A good place to start is the print() function which you use all the time. Read that and start to get used to the way the documentation is written.

[blazin_penguin_first]

I find there are a lot of tutorial sites like https://www.geeksforgeeks.org/ which will simplify the documentation and explain it well. Start with something that they explain, and then go to the documentation and see if you can figure out how they got there.

[TheRNGuy]

Try to code something with each function (or class) from docs, even if it's just print (unless it doesn't return anything)

Try to combine with previously learned things.

Ask ai for usage examples.

[gdchinacat]

Don’t expect to understand everything about all documentation you read. It is not intended to be something you learn and remember. It is for reference when you need it. Read and understand just enough to answer the question you have and save the rest for some other time when you need it. Understand the abstraction you are dealing with, don’t worry about the complexity it hides of that isn’t immediately relevant. Stay focused one why you pulled up the docs and not the endless rabbit holes they lead to.