Fix the doc warning attribute and document remaining items for bevy_window
#9933
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
|
|
Document the remaining items, fix the doc warning attribute and remove some unused getters
Kanabenki
force-pushed
the
bevy_window-doc
branch
from
0797fc1 to
4e63c81
Compare
mockersf
added
C-Docs
mockersf
approved these changes
Sep 26, 2023
Aceeri
reviewed
Sep 26, 2023
| @@ -1,6 +1,12 @@ | |||
| #![allow(clippy::type_complexity)] | |||
| #![warn(missing_docs)] | |||
There was a problem hiding this comment.
Should we just #[deny(missing_docs)] here from now on?
There was a problem hiding this comment.
I kept warn since that's what seems to be intended to be put for all crates in the long run, according to #3492.
Aceeri
approved these changes
Sep 27, 2023
mockersf
added
the
S-Ready-For-Final-Review
45 tasks
rdrpenguin04
pushed a commit
to rdrpenguin04/bevy
that referenced
this pull request
Jan 9, 2024
…window` (bevyengine#9933) # Objective Complete the documentation for `bevy_window`. ## Solution The `warn(missing_doc)` attribute was only applying to the `cursor` module as it was declared as an inner attribute. I switched it to an outer attribute and documented the remaining items.
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
Complete the documentation for
bevy_window.Solution
The
warn(missing_doc)attribute was only applying to thecursormodule as it was declared as an inner attribute. I switched it to an outer attribute and documented the remaining items.