Replace or document ignored doctests#11040
Merged
alice-i-cecile merged 9 commits intobevyengine:mainfrom Jan 1, 2024
Merged
Conversation
mockersf
reviewed
Dec 20, 2023
mockersf
reviewed
Dec 20, 2023
Co-authored-by: François <mockersf@gmail.com>
alice-i-cecile
approved these changes
Dec 21, 2023
Member
alice-i-cecile
left a comment
alice-i-cecile
left a comment
There was a problem hiding this comment.
Very fond of these changes. CI appears to be failing though.
alice-i-cecile
added
C-Code-Quality
Contributor
Author
|
All comments are resolved. Should be ready for merge now! |
mockersf
approved these changes
Jan 1, 2024
mockersf
added
the
S-Ready-For-Final-Review
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
4 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
There are a lot of doctests that are
ignored for no documented reason. And that should be fixed.Solution
I searched the bevy repo with the regex
```[a-z,]*ignorein order to find allignored doctests. For each one of theignored doctests, I did the following steps:ignoredattribute while still passing the test. I did this by adding hidden dummy structs and imports.ignoredattribute with theno_runattribute while still passing the test.ignoredattribute but add documentation for why theignoredattribute was added.