unconditionally complains about short descriptions about dart-shapeshift HOT 7 OPEN

Not sure what to do about this one. My opinion is that it should complain about every short description (especially at the class level), and devs shouldn't worry about hitting 100% doc coverage.

from dart-shapeshift.

As a fan of short comments, I tend to agree FWIW.

Where's the logic for this analysis BTW? I was expecting to see it here?

from dart-shapeshift.

Sorry, @pq, it should be there, but its in an older bit of code. I'm working on cleaning up the internals as we speak :)

from dart-shapeshift.

In general, I would like to make the doc coverage tool configurable, so you can leave out certain complaints. That might be a ways off :)

from dart-shapeshift.

Cool. Thanks for the pointer. Configurability is a tough one. Hopefully you won't need too much of it.

In this case, it's interesting. If I'm reading this right, you're minimum is 2 lines? Curious how well the SDK fares against this standard. I'm thinking getters in particular would commonly have just one line.

from dart-shapeshift.

That should just be for "top-level" comments (for classes and libraries, not methods).

from dart-shapeshift.

Aha. That's better! :)

In the long run, I should get a handle on the exact rules so we can codify the appropriate ones in the linter as well. Anyway, we can connect on that down the road.

Thanks!

from dart-shapeshift.