Announcing YARD-Lint: Keep Your Ruby Documentation Solid

I was just thinking today about how much I dislike YARD docs. Take the example for instance, it is nearly twice the size of the method itself. I dislike nothing more than having a bunch of docs I won't read clogging up my limited screen real estate. A class that should fit in one screen now fits on two or three and I have to scroll up and down to get the whole context in my brain. The fact that it specifies argument and return types annoys me too when the code will work perfectly fine with any object that responds to those messages.

I think it's perfectly reasonable to put YARD docs on the API layer of your system so consumers can see loosely what their calls should look like. I think it's a lot less reasonable to put them on every single method.