3 ms·
I generally enjoy a brief description of the overlying concept, at the top of each function. I don't care to know how a function is implemented as much as rough
by nomel 5y ago
I generally enjoy a brief description of the overlying concept, at the top of each function. I don't care to know how a function is implemented as much as rough details to help me navigate the new/forgotten code space/context. Usually, a quick example of usage, within some relevant context, is enough to push me in the right direction.
If I have to read every line of implementation to know wtf is going on, then I'm probably going to have a bad time.