search

csells / go_router

The purpose of the go_router for Flutter is to use declarative routes to reduce complexity, regardless of the platform you're targeting (mobile, web, desktop), handling deep linking from Android, iOS and the web while still allowing an easy-to-use developer experience.
https://gorouter.dev
442 stars 96 forks source link

fix API coverage #43

Closed csells closed 2 years ago

csells commented 2 years ago

44.6% is not OK!

image

rydmike commented 2 years ago

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.

csells commented 2 years ago

Thanks, @rydmike! Fixed in v1.1.2.