Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Replace or document ignored doctests #11040

Merged
merged 9 commits into from
Jan 1, 2024
Merged

Replace or document ignored doctests #11040

merged 9 commits into from
Jan 1, 2024

Conversation

doonv
Copy link
Contributor

@doonv doonv commented Dec 20, 2023

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,]*ignore in order to find all ignored doctests. For each one of the ignored doctests, I did the following steps:

  1. Attempt to remove the ignored attribute while still passing the test. I did this by adding hidden dummy structs and imports.
  2. If step 1 doesn't work, attempt to replace the ignored attribute with the no_run attribute while still passing the test.
  3. If step 2 doesn't work, keep the ignored attribute but add documentation for why the ignored attribute was added.

mockersf
mockersf reviewed Dec 20, 2023
View reviewed changes
errors/B0003.md Outdated Show resolved Hide resolved
@doonv @mockersf
Apply suggestion in crates/bevy_reflect/src/type_registry.rs
71dd122 
Co-authored-by: François <mockersf@gmail.com>
@ItsDoot ItsDoot added the C-Docs An addition or correction to our documentation label Dec 20, 2023
alice-i-cecile
alice-i-cecile approved these changes Dec 21, 2023
View reviewed changes
Copy link
Member

@alice-i-cecile alice-i-cecile left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very fond of these changes. CI appears to be failing though.

@alice-i-cecile alice-i-cecile added C-Code-Quality A section of code that is hard to understand or change C-Testing A change that impacts how we test Bevy or how users test their apps labels Dec 21, 2023
@doonv
Copy link
Contributor Author

doonv commented Jan 1, 2024

All comments are resolved. Should be ready for merge now!

@mockersf mockersf added the S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it label Jan 1, 2024
@alice-i-cecile alice-i-cecile added this pull request to the merge queue Jan 1, 2024
Merged via the queue into bevyengine:main with commit 189ceaf Jan 1, 2024
23 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mockersf mockersf mockersf approved these changes

@alice-i-cecile alice-i-cecile alice-i-cecile approved these changes

Assignees
No one assigned
Labels
C-Code-Quality A section of code that is hard to understand or change C-Docs An addition or correction to our documentation C-Testing A change that impacts how we test Bevy or how users test their apps S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@doonv @alice-i-cecile @mockersf @ItsDoot