3 ms·
OT, but this is my number one peeve with code documentation: going to the effort to write a doc comment, taking up at least 6 lines, probably using some special
by tomn 3y ago
OT, but this is my number one peeve with code documentation: going to the effort to write a doc comment, taking up at least 6 lines, probably using some special syntax, cluttering up the code, but then adding no information that can't be derived from the signature.
If you're not going to document something (which I totally respect), at least don't make the code worse while doing it.
- ddejohn 3y agoEven better when the docstring doesn't even match the signature.