How To Read Documentations For Beginners

[@john5s]

Sorry man, this was not helpful. I was hopping this video was going to help me understand how to decode what the document was talking about. like with the python print example. what are all the other option/parameters? how do determine if they are required or optional? So I get overwhelmed by the docs and then don't read them.

[@exdcode3369]

Damn, what a great feedback while being nice when disagreeing! I'm sure you'll get there and would find your answers! Have a nice day 😊

[@Drathgore]

at that point your problem isn't not knowing how to read documentation, its just not knowing python syntax in the first place. you need to take a step back and fill in gaps in your knowledge about the fundamentals

[@reinerzufall3123]

I come from a Java background and the documentation is written in a way that makes it super easy to understand. I can't get to grips with the Python documentation either and have exactly the same problem as you - how am I supposed to read it all, all the parameters, what is mandatory and what is not. These docs are terrible^^

[@tehyonglip9203]

Documentation is like a handbook/dictionary, you don't read them, you use them by referring them when you need it

[@rudraanshpatel553]

00:00 Learn how to properly read documentation 02:10 Reading documentation is important for programmers 04:19 Navigating documentation is easier when you understand its structure 06:32 Documentation is for getting started or looking up specific functions 08:35 Using documentation to understand default values and parameters 10:42 Finding documentation for Python packages 12:53 To understand code, go to the documentation and source code 14:56 Reading documentation: Getting started, User guide, and API reference

[@Maik.iptoux]

Problems with documentation, you need to know the function to search for it. When you have logical problem or something where you don't know the way, the documentation will not help. Because you can't ask like "How i do ..."

[@nasim3987]

One solution is to create a T-shaped understanding of the entire documentation.

[@voidzz7969]

@@nasim3987 elaborate? I think I understand a little

[@Drathgore]

in theory thats where the user guide /getting started style docs come in, the people making the library being documented should explain the normal use cases for what you would typically be doing and whats possible, and then you fill in the gaps and go from there using the reference. again, thats only in theory sadly lol

[@samandarkhan2431]

well now, u can ask LLMs for that !!

[@michaelgrubhofer1216]

Yessss! I was looking exactly for that a few days ago! That's a meta skill! Thanks!

[@abdallahahmed7546]

One more video about how to write documentation :-)

[@guolu-mi2kr]

copy a doc like pandas'doc and modify it directly

[@yuvrajsingh-gm6zk]

Thanks for sharing, really appreciate that. especially the ctrl+click that was a game changer for me!

[@michaelponce5965]

Thank you for this! I felt pretty dumb searching for a 'how to read instructions' video hahaha. I didn't know about the CTRL+click on the package name to get the source code thing, so thanks for that as well.

[@설리-o2w]

Stackoverflow is old news i find myself using chatgpt often :)

[@mohamedibrahemsaad573]

what if I want you study from scratch using only the documentation?

[@EdictaMG]

This was very helpful! Thank you for putting this video together for us.

[@NeuralNine]

Glad to hear you like it!

[@constructivecriticism3674]

thanks for the video you should have also explained how to look up for *args and **kwargs parent class

[@distant6606]

Good video idea. Stack overflow mods approve!

[@Ryan-ul7dy]

ChatGPT also useful for more common libraries but it only records updates up until September 2021

[@philipe1502]

Couldn't it be useful if you just copy paste all the docs and ask him questions about them? Then he doesn't have to refer to them by Sept 21 memory.

[@archiemarqx]

​@@philipe1502 Just copy and paste the link for the specific page that you want to know about documentation. Then, he will give you "updated" answers.

[@rmt3589]

Ah. So Phind should also be able to help me with this as well.

[@nasenbar5417]

I am a beginner...I am in love with the PHP documentation

[@4zdr456]

Sounds a bit greek myth to me

[@borincod]

it is often much faster and on point to ask AI. The trick is the question should be rather on basics

[@elchemyst]

Thanks Mr. Victor Krum

[@zerogravity6025]

2:20 start video

[@JonJones-pz9kb]

thank you i didnot know this.

[@almondjartone1206]

aye I liked the video of a tutorial on how to make a tutorial, this is valid

[@julynnix7989]

Thanks brother, I needed this!

[@Eyalgazit]

Very informative

[@ranggayogiswara5148]

It funny because people said "RTFM" when we literally can't read the manual😂😂😂

[@un_chien_andalou]

You don't even know how much you helped me, thanks!

[@unknownfactor6489]

Thank you kind sir

[@pythonholic]

Eid mobarak

[@phurbutsering4485]

fyi "RTFM" full form is "read the fucking manual"

[@badmonkey2468]

I searched for this

[@woahwoah156]

Thanks.

[@hardworkerarmy5090]

Thanks For Making Video On this Topic

[@blahblah12390]

Thats what i want know

[@akobd]

too much talkative without any real matter up to 8 minutes. for reading doc, need to understand the meaning of symbol enclosed text, identify mandatory and optional part and others things, which i don't know thus watched your video to know but disappointed totally

[@andremorinigo433]

oh great

[@TravisTennies]

So tired of people uploading videos and not explain what the title says they are going to explain.

[@Born2Fail]

freaking lame Video....people clidked on your video thinking you would be explaining things like ~breakpoint(*args, **kws)~ all the key words or at least the most important ones like kws, args and what they mean or what people can pass through them. you explained to people how to read a book. congrats to all of us!

[@hajji384]

😂 if you need to be pro atleast read docs everyday for 1hr.

[@techspark001]

bro all the 2 minute talk was unnecessary, we came here to learn to how do it so just go straight to the point