Skip to content
This repository has been archived by the owner on Feb 25, 2022. It is now read-only.

fix API coverage #43

Closed
csells opened this issue Sep 30, 2021 · 2 comments · Fixed by #51
Closed

fix API coverage #43

csells opened this issue Sep 30, 2021 · 2 comments · Fixed by #51
Labels
documentation Improvements or additions to documentation

Comments

@csells
Copy link
Owner

csells commented Sep 30, 2021

44.6% is not OK!

image
@csells csells added the documentation Improvements or additions to documentation label Sep 30, 2021
@rydmike
Copy link
Contributor

rydmike commented Oct 2, 2021

Just a suggestion, but if you turn on the lint public_member_api_docs that you disabled, and turn it off in the examples, we don't need it there. Then you will be able to easily find all the public APIs that pub.dev is not happy about that are missing.

While going through the code, I did so, and added the missing API doc comments. Submitting a PR, use them if you like. Of course feel free to improve the doc comments. In some cases I was not entirely up to speed on what a good comment would be.
Also in some cases I edited existing doc comments to make them follow the Dart doc comments recommended style, so they are sentences that start with capital letter and end with a period. Does not matter so much in the code comments, but looks much better when it becomes doc pages.

@rydmike rydmike mentioned this issue Oct 2, 2021
Merged
@csells csells closed this as completed in #51 Oct 2, 2021
@csells
Copy link
Owner Author

csells commented Oct 2, 2021 •
edited
Loading

Thanks, @rydmike! Fixed in v1.1.2.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Added missing API doc comments and updated to sentence style. rydmike/go_router
2 participants
@csells @rydmike