Ranter
Join devRant
Do all the things like
++ or -- rants, post your own rants, comment on others' rants and build your customized dev avatar
Sign Up
Pipeless API
From the creators of devRant, Pipeless lets you power real-time personalized recommendations and activity feeds using a simple API
Learn More
Comments
-
Eklavya17723ySo, instead of reading the whole fucking documentation, we should read the whole fucking code
-
Yeah, download the linux kernel source code yourself because you know fuck documentation
-
C0D4681463y@Eklavya 👀 I didn't say that
Wow you guys go straight to the problem on this one. Documentation can lie or be outdated, so yes it's usually incorrect making the code the source of truth, should you have to read the code to understand what's going on? No. -
@C0D4 whenever I make sth i take a page from the REACT documentation site, it has everything you will ever need to know about the framework and that's really sth.
-
nebula18703yone could also argue:
if your code does not match docs that's a bug, because it does not behave like documented. -
Voxera115853y@nebula but in many cases this is a bug in the documentation ;). But yes, still a bug.
-
rittmann1053yDocumentation? What's that? Is it to eat? Is it to drink? Is it an animal? Is it a plane?
My dream is founding a documented project
Related Rants
No matter how much documentation you write, and how well you comment the code, the truth is always the code itself.
random
never up to date
documentation != truth
an industry of inconsistency
always incorrect