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.
Problem
sphinx.ext.doctest
renderstestcode
anddoctest
blocks in our documentation. While rendering documentation, the extension complains about our customMOCK
option:This wasn't caught before because warnings were accidentally disabled by ray-project/ray#32741.
Solution
Make
SKIP
behave likeMOCK
.SKIP
is a valid option. It tells Sphinx to completely skip an example. To avoid warnings, this PR changes the behavior ofSKIP
so that it runs example code but skips the output.This won't cause any problems:
SKIP
anywhere, so this wouldn't break anything. `SKIP
is functionally equivalent toskipif: True
, so we can still completely skip examples if we want to.