-
-
Notifications
You must be signed in to change notification settings - Fork 676
Minimal docs at module level #2639
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
249101a to
cbdba94
Compare
|
Next time, I should remember running rustfmt and cargo clippy before pushing ... |
extrawurst
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Lets remove commitlist and cmdbar mod comments as it feels arbitrary to only add them for these.
In general I dont want to list stuff that will easily get outdated like in your main.rs comment.
I prefer a mod comment over a parent mod comment explaining its sub-mods
|
Removed commitlist and cmdbar mod coments. |
746bb47 to
702b675
Compare
|
github says there is one more requested change, but I think I did address them all. |
cruessler
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think the docs are really helpful! I think this can be merged. In case anyone wants further changes I suggest iterating after merging.
extrawurst
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍
This Pull Request provides minimal top-level documentation.
This makes the initial navigation of cargo docs easier.
It changes the following:
I followed the checklist:
make checkwithout errors