Skip to content

Commit 0f37dbe

Browse files
display python imports in first example in tutorial
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.
1 parent c513aa9 commit 0f37dbe

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

docs/tutorial.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ Here is the full ReFrame test:
8585

8686
.. literalinclude:: ../examples/tutorial/stream/stream_runonly.py
8787
:caption:
88-
:pyobject: stream_test
88+
:lines: 5-
8989

9090
ReFrame tests are specially decorated classes that ultimately derive from the :class:`~reframe.core.pipeline.RegressionTest` class.
9191
Since we only want to run an executable in this first test, we derive from the :class:`~reframe.core.pipeline.RunOnlyRegressionTest` class, which essentially short-circuits the "compile" stage of the test.

0 commit comments

Comments
 (0)