[doc] Display Python imports in the first tutorial example #3195
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
|
Can I test this patch? |
vkarak
requested changes
May 15, 2024
createyourpersonalaccount
force-pushed
the
fixing-tutorial
branch
2 times, most recently
from
59ef58e
to
3805a92
Compare
The tutorial was skipping the two imports
import reframe as rfm
import reframe.utility.sanity as sn
by using the :pyobject: option to only highlight stream_test. This is
the first example shown in the tutorial and it is important that the
entire file is displayed.
Presumably this technique is used to avoid the license notice; we can
use :lines: instead.
createyourpersonalaccount
force-pushed
the
fixing-tutorial
branch
from
3805a92
to
0f37dbe
Compare
vkarak
approved these changes
May 15, 2024
vkarak
changed the title
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.
The tutorial was skipping the two imports
by using the :pyobject: option to only highlight stream_test. This is the first example shown in the tutorial and it is important that the entire file is displayed.
Presumably this technique is used to avoid the license notice; we can use :start-at: instead.