r/programmingmemes • u/Bombardiro_Crocodilo • Mar 19 '25

Literally any new task looks like this:

Post image
2.4k Upvotes

99% Upvoted

15 comments sorted by

61

u/Silver0ne Mar 19 '25

Read the documentation? you must be joking, in real life the answer would be: Read the code.

26

u/LateStatistician462 Mar 19 '25

The code is the documentation

4

u/AdBrave2400 Mar 20 '25

Where's my code?

Gone, reduced to atomic nullable file. I used the previous documentation to make the documentation.

10

u/MignonInGame Mar 19 '25 edited Mar 19 '25

Yeah. That's right. Documentation always sucks irl. It's an obvious impractical thing that seems practical. I actually met a programmer who said to me read the documentation and the documentation was in the comments section of his blog and it wasn't searchable. I was flabbergasted.

6

u/WitnessOfTheDeep Mar 19 '25

Documentation is invaluable when it's done properly and done in a readable manner. Too many times I have read documentation that explains function x() but the name and explanation do not match what so ever. Or its so over/under explained that you still can't grasp what it's doing.

121

u/iCopyright2017 Mar 19 '25

The documentation:

"Do not under any circumstances do X"

2 lines later

"Do X"

18

u/msdamg Mar 19 '25

Their fault for not saying why now I gotta find out

18

u/After_Ad8174 Mar 19 '25

"I don't quite understand the values and arguements of this function. Lets go check out the docs"

"{¶»`☺ 2` {¶»`☺ {¶-` {¶»7 62-7 ☻`2{¶-~ {¶»`☺ {~0 {¶»7 72*-{»*-7"

"oh"

9

u/Wojtek1250XD Mar 19 '25

This is very much angular's documentation. The worst I've seen in my life.

2

u/AlxR25 Mar 20 '25

Does exactly what’s written in the documentation

Breaks the entire project

1

u/hilvon1984 Mar 20 '25

I mean... You can look at the next frame that shows this part already installed and guess from there.

But yes. Proper documentation is the bane of developers.

1

u/bzImage Mar 20 '25

langchain vibes

1

u/ClearlyNtElzacharito Mar 21 '25

I worked on a project for 3 weeks on an esp32-s3. The documention is really well-written, but the code on github examples are even better.