Added three tab option to sphinx directive codediff and added testing for first tab
#3847
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
chiamp
force-pushed
the
haiku
branch
15 times, most recently
from
ed7eaf5
to
a1617d2
Compare
chiamp
changed the title
codediff and added testing for first tab
chiamp
force-pushed
the
haiku
branch
2 times, most recently
from
b4da308
to
81d5bec
Compare
chiamp
force-pushed
the
haiku
branch
10 times, most recently
from
e005f10
to
193bda2
Compare
chiamp
force-pushed
the
haiku
branch
20 times, most recently
from
9599edb
to
e27f0c3
Compare
cgarciae
approved these changes
May 7, 2024
chiamp
force-pushed
the
haiku
branch
3 times, most recently
from
fcf1554
to
d9e6ca2
Compare
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.
This PR does the following:
skip_testto skip doctesting for any number of tabs. This is useful for legacy code snippets that no longer work in migration guidesgroupsto allow user to denote which code snippets should be grouped and executed togetherSee the docstring for more details on how to use the
codediffdirective.This is in preparation for adding an NNX tab in the haiku migration guide, for users who want to compare the differences between Haiku, Linen and NNX.
This PR does the following:updated sphinx directive codediff to have the option of including a third tab (title_middle) for code diffadded testing for the first tab, since it wasn't tested before by doctestaddedskip_left_doctestto skip doctesting of legacy code snippets (in the left tab) that no longer work in migration guidesadded user option to denote whether a code snippet should executed in the left (testcode_left) or right (testcode_right) tab, or bothThis is in preparation for adding an NNX tab in the haiku migration guide, for users who want to compare the differences between Haiku, Linen and NNX.