[Merged by Bors] - Bevy app docs#3539
Conversation
Achieves 100% doc coverage for public items in the bevy_app crate. Also, fixes a couple of minor typos in other crates.
alice-i-cecile
added
C-Docs
inodentry
left a comment
inodentry
left a comment
There was a problem hiding this comment.
Your current docs seem a little out-of-place IMO, in that they explain things that aren't directly relevant to understanding App, and don't explain things that are.
I've left you some constructive criticism with suggestions for what to document instead. :)
Also, it is a convention to have the first line of a doc comment be a brief statement of what the thing is, and then have any additional explanation on following lines. Rustdoc will display the first line as the description in brief listings, like search results. You don't want to clutter it with too much text.
Co-authored-by: Alice Cecile <[email protected]>
Co-authored-by: Alice Cecile <[email protected]>
alice-i-cecile
left a comment
alice-i-cecile
left a comment
There was a problem hiding this comment.
A few more typos and thoughts. The framing of how we introduce App is particularly critical for the new user experience, so we should spend more time trying to really nail the explanation than might be justified otherwise. The existing docs are fine, but these should be excellent.
killercup
left a comment
killercup
left a comment
There was a problem hiding this comment.
LGTM, left some comments on unimportant details :)
Co-authored-by: Pascal Hertleif <[email protected]>
Co-authored-by: Pascal Hertleif <[email protected]>
Co-authored-by: Pascal Hertleif <[email protected]>
|
bors r+ |
# Objective Achieve 100% documentation coverage for bevy_app crate. See #3492 ## Solution - Add #![warn(missing_docs)] to crate root - Add doc comments to public items - Add doc comment to bevy_utils::define_label macro trait
|
🔒 Permission denied Existing reviewers: click here to make dbearden a reviewer |
|
@dbearden That permission is for Cart, Francois and myself :) We just need to wait for the |
|
Oops :p |
|
bors seems stuck. Let's try again... |
|
bors r- |
|
Canceled. |
|
bors r+ |
# Objective Achieve 100% documentation coverage for bevy_app crate. See #3492 ## Solution - Add #![warn(missing_docs)] to crate root - Add doc comments to public items - Add doc comment to bevy_utils::define_label macro trait
4 participants
Objective
Achieve 100% documentation coverage for bevy_app crate.
See #3492
Solution