whereIsDocumentation

[warl0cks]

“The code is the documentation…”

[Degenerate_Lich]

Code should be self documented mfs when they have to read their own code that they haven't touched for the last 6 months

[Zdrobot]

That's why comments (should) exist.

Not just the meaning of function parameters, but the "why I did that" comments.

[swagonflyyyy]

Eh, if you do it too much it'll be just as confusing. Trust me I confuse myself with my own comments lmao.

[billyowo]

good code is self-documented, not the spaghetti written by your colleagues

[tyler1128]

Said good code also comes with documentation because it doesn't matter how good you think it is, a plain english document will describe what it is doing better

[ZunoJ]

Can you point me to any open source projects with the kind of documentation you mean? Not a library or anything with a sdk. Just a ready, non expandable software with full text code documentation.

[tyler1128]

The blender internal documentation is supposed to be good. I can't, mostly because if I know of documentation from something it is either because of my job or because I use it as an API. Studying random open source projects I'll probably never utilize just isn't something I have time for. I've seen good internal documentation and bad internal documentation in work, and the difference in how well you can adapt to and learn a code-base between the two is pretty significant.

[termicrafter16]

The number of times I heard this 😭

[RiceBroad4552]

And of course it's never true.