Skip to content

Commit f4a88b7

Browse files
vkarakekouts
andauthored
Address PR comments
Co-authored-by: Eirini Koutsaniti <[email protected]>
1 parent 44243cb commit f4a88b7

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

docs/tutorial_basics.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -431,7 +431,7 @@ You can set environment variables in a ReFrame test through the :attr:`~reframe.
431431
What makes a ReFrame test a performance test is the definition of at least one :ref:`performance function<deferrable-performance-functions>`.
432432
Similarly to a test's :func:`@sanity_function<reframe.core.builtins.sanity_function>`, a performance function is a member function decorated with the :func:`@performance_function<reframe.core.builtins.performance_function>` decorator that merely extracts or computes a performance metric from the test's output and associates it with a unit.
433433
By default, every performance function defined in the test is assigned to a *performance variable* with the function's name.
434-
A performance variable is a named quantity representing a performance metric that ReFrame will report on it, log it and can also check it against a reference value.
434+
A performance variable is a named quantity representing a performance metric that ReFrame will report on, log and can also check against a reference value.
435435
The performance variables of a test are stored in the :attr:`~reframe.core.pipeline.RegressionTest.perf_variables` dictionary.
436436
The keys are the names of the metrics, whereas the values are :ref:`performance functions <deferrable-performance-functions>`.
437437
The :func:`@performance_function<reframe.core.builtins.performance_function>` decorator apart from turning an ordinary method into a "performance function", it also creates an entry in the :attr:`~reframe.core.pipeline.RegressionTest.perf_variables` dictionary.

0 commit comments

Comments
 (0)