Add documentation comments to bevy_winit
#8115
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
beeryt
changed the title
bevy_windowbevy_winit
mockersf
reviewed
Mar 17, 2023
|
it seems you missed adding |
mockersf
added
C-Docs
It appears that I did... and I'm also missing comments for the crate and |
cart
approved these changes
Mar 21, 2023
Vrixyz
reviewed
May 7, 2023
Comment on lines
+24
to
26
| /// A resource which maps window entities to [`winit`] library windows. | ||
| #[derive(Debug, Default)] | ||
| pub struct WinitWindows { |
There was a problem hiding this comment.
Sorry to come back after this PR is merged; but is this documentation accurate ? as the struct doesn't derive Resource, it's not a resource 🤔 ?
45 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Objective
bevy_winit#![warn(missing_docs)]tobevy_winit.Relates to #3492