Took 200 points of psychic damage after hearing “the code is the documentation” being called the state of the art.
Code should be as easy to understand as possible but is not a replacement for documentation. You resort to reading code when the documentation is incomplete or the API leaks wildly. I assume this convention was started because it’s difficult to keep documentation in sync with code changes and developers hate writing documentation, but these are all team process failures. Switching to an equally hard task (ensuring code is easy to understand and has a consistent and predictable implementation) is not going to magically cover up these process failures. A team that can’t keep documentation in sync is probably not going to produce great APIs that are easy to understand without documentation.
Also this was said about Unreal Engine which is fucking hilarious like who is going to read UE code to figure out how to use the Gameplay Framework API from scratch?? I am not gonna read all the code to figure out what a parameter does. I’d like to figure this out in the next 50 years if that’s ok.
