6 ms·
> Its been said that the best documentation is source code fuck you. it's a myth perpetrated by lazy programmers, who can't be bothered to spend an hour or two
by maydup-nem 5y ago
> Its been said that the best documentation is source code
fuck you. it's a myth perpetrated by lazy programmers, who can't be bothered to spend an hour or two writing a comprehensible usage manual, while otherwise EVERY USER IS GUARANTEED to spend MORE just figuring out how to BEGIN using his crap. It's only forgivable for the simplest of self-explanatory /API/ calls, but /nothing/ in userspace.
- croon 5y agoEdit out the expletive and replace the caps with ~ before and after and I'll agree with everything else in the comment.
- matthewh806 5y agowhat a tiresome bore you sound
- dang 5y agoPlease don't cross into personal attack or name-calling, regardless of how bad another comment is or you feel it is. https://news.ycombinator.com/newsguidelines.html https://news.ycombinator.com/newsguidelines.html
- forty 5y agoI think your comment can be improved by removing your first two words, which brings nothing to this conversation.
- maydup-nem 5y agoIt's too often that developers adopt this attitude that I have to resort to vulgarity. They are practically forcing my hand there.
- craftinator 5y agoThe "my actions are THEIR fault" excuse only works in The Manchurian Candidate.
- gadrev 5y agoSomehow I agree with both parent and you. Ah, life is never black and white...
- spockz 5y agoDocumentation != user guide or manual. Manual are part of the documentation. And it is still true that the source code is the best documentation, ideally the source code can be used to automatically generate the docs. But overall documentation and things like ADR will hardly ever find their way into the source so require writing then externally.
- maydup-nem 5y ago> Documentation != user guide or manual It is within this comment section: > forgo any kind of documentation: what options are supported by specific commands, what behaviours they exhibit
- dang-guefever 5y agoI too am unskilled at navigating unfamiliar codebases and demand clifnotes because my time as a user is more valuable than yours as a programmer. these gift horses are AWFUL
- dang 5y agoPosting like this will get you banned here, so please don't do that. If you wouldn't mind reviewing https://news.ycombinator.com/newsguidelines.html https://news.ycombinator.com/newsguidelines.html and taking the intended spirit of the site more to heart, we'd be grateful. In particular, we don't want flamewars, and you've unfortunately already posted quite a few flamewar comments. Can you stick to thoughtful, curious comments instead? That's the kind of conversation we're trying for here. Note that that includes being respectful to whomever you're talking with, regardless of how wrong they are or you feel they are.