[Merged by Bors] - Added missing docs to bevy_internal and added warn on missing docs#3514
Closed
Sheepyhead wants to merge 4 commits intobevyengine:mainfrom
Closed
[Merged by Bors] - Added missing docs to bevy_internal and added warn on missing docs#3514Sheepyhead wants to merge 4 commits intobevyengine:mainfrom
Sheepyhead wants to merge 4 commits intobevyengine:mainfrom
Conversation
alice-i-cecile
added
C-Docs
alice-i-cecile
approved these changes
Jan 1, 2022
alice-i-cecile
added
the
S-Ready-For-Final-Review
Member
|
Extremely complex code, impeccable documented. Thanks! @mockersf, feel free to merge this one ASAP. |
alice-i-cecile
removed
the
S-Ready-For-Final-Review
Member
|
As discussed on Discord, we should have a module level doc comment that explains that this is seperate from the |
45 tasks
Contributor
Author
I added a line mentioning this, if a more in depth explanation is necessary I need someone who actually understands why this separation is necessary to help me writing it |
bjorn3
reviewed
Jan 1, 2022
Member
|
bors r+ |
Contributor
|
Pull request successfully merged into main. Build succeeded! And happy new year! 🎉 |
bors
bot
changed the title
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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
This contributes documentation that should cover the entirety of bevy_internal as requested in #3492
Solution
warn(missing_docs) has been activated and documentation has been added to missing parts so that no warnings appear from this setting