4 ms·
People who release undocumented code have no sense of social responsibility, and they are wasting everyone else's time. The only way you can figure out if thes
by radiac 14y ago
People who release undocumented code have no sense of social responsibility, and they are wasting everyone else's time.
The only way you can figure out if these releases do what you want is to spend half an hour trawling through the source code. Over the years I must have wasted weeks of productive time doing just that, and I can't believe I'm the only person who has.
I don't expect full API documentation and set of unit tests for every open source project - I'd be happy if most projects came with a short overview of how the code works, how it is implemented, maybe a couple of examples, and a list of its limitations. I do that for most projects I write for myself, to make it easier to come back to in a year or two when I next need to work on it.
If your project isn't worth spending an hour writing some basic documentation, then it isn't worth releasing.