Executing only parts of the analysation when you try to improve your package

[rekire]

Executing only parts of the analysation when you try to improve your package

[rekire]

To simplify this issue: The output could suggest to use that lint warning. With that hint I would have not opened this issue.

[srawlins]

Sorry for my delayed response. I thought to myself "Could I implement this real quick in dartdoc? How would I do that?" And realized I should look into the warnings system. It turns out we have one warning in place: no-library-level-docs. I can't remember exactly now, but I think warnings are enabled with dart bin/dartdoc.dart --warnings no-library-level-docs.

Checks for docs for public API will probably be trickier, because of inheritance. 😬

[goderbauer]

There's also the public_member_api_docs lint [1] that flags all members missing API docs. That's what we use in the Flutter framework to make sure everything is documented.

cc @srawlins for dartdoc.

[1] https://dart.dev/tools/linter-rules/public_member_api_docs

[sigurdm]

@rekire does the public_member_api_docs lint work well enough for you? That should give you a list of all missing docs when you run dart analyze (or right in the IDE).

[rekire]

I would need to check again, but I guess it is missing the library; statements.

Edit: My assumption was right pana want those library; statements with documentation, while the public_member_api_docs linter does not expect it.

But to be honest that is nothing wild anymore.

(Unfunny) Funfact: Regarding that lint, in that special project I accidentally disabled that lint rule.

[sigurdm]

We should probably align between that lint and the dartdoc requirement.
My gut feeling says that the lint should also cover libraries...

[sigurdm]

Ah - of course - let's do that!

[isoos]

To simplify this issue: The output could suggest to use that lint warning. With that hint I would have not opened this issue.

In itself such lint would not be enough to 1:1 mirror the current analysis, which has a threshold for reporting missing API docs (currently at 20%), as the lints would only return the missing ones, and we are missing the total count of API symbols.

However, if you are only interested in having all your API symbols documented, by all means use the lint, as it will give you the feedback much faster than running dartdoc as a separate process.

[rekire]

I had out of the box more then 20% I just aimed to have 100%. Might be also some hint of the library; statement would be nice ether. I was not aware of that keyword before I tried to get 100%.

[sigurdm]

Opened dart-lang/linter#4962 for alignment on the lint. Closing this issue as I don't think we want to do more in pana.