Skip to content

Commit 13abab8

Browse files
committed
Add a warning in documentation about perf_patterns
1 parent eff1c97 commit 13abab8

File tree

1 file changed

+10
-5
lines changed

1 file changed

+10
-5
lines changed

reframe/core/pipeline.py

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -702,16 +702,21 @@ def pipeline_hooks(cls):
702702

703703
#: Patterns for verifying the performance of this test.
704704
#:
705-
#: Refer to the :doc:`ReFrame Tutorials </tutorials>` for concrete usage
706-
#: examples.
707-
#:
708705
#: If set to :class:`None`, no performance checking will be performed.
709706
#:
710707
#: :type: A dictionary with keys of type :class:`str` and deferrable
711708
#: expressions (i.e., the result of a :doc:`sanity function
712709
#: </deferrable_functions_reference>`) as values.
713710
#: :class:`None` is also allowed.
714711
#: :default: :class:`None`
712+
#:
713+
#: .. warning::
714+
#:
715+
#: You are advised to follow the new syntax for defining performance
716+
#: variables in your tests using either the :func:`@performance_function
717+
#: <reframe.core.builtins.performance_function>` builtin or the
718+
#: :attr:`perf_variables`, as :attr:`perf_patterns` will likely be
719+
#: deprecated in the future.
715720
perf_patterns = variable(typ.Dict[str, _DeferredExpression], type(None))
716721

717722
#: The performance variables associated with the test.
@@ -725,7 +730,7 @@ def pipeline_hooks(cls):
725730
#: By default, ReFrame will populate this field during the test's
726731
#: instantiation with all the member functions decorated with the
727732
#: :func:`@performance_function
728-
#: <reframe.core.pipeline.RegressionMixin.performance_function>` decorator.
733+
#: <reframe.core.builtins.performance_function>` decorator.
729734
#: If no performance functions are present in the class, no performance
730735
#: checking or reporting will be carried out.
731736
#:
@@ -743,7 +748,7 @@ def pipeline_hooks(cls):
743748
#: :ref:`deferrable-performance-functions`).
744749
#: :default: Collection of performance variables associated to each of
745750
#: the member functions decorated with the :func:`@performance_function
746-
#: <reframe.core.pipeline.RegressionMixin.performance_function>`
751+
#: <reframe.core.builtins.performance_function>`
747752
#: decorator.
748753
#:
749754
#: .. versionadded:: 3.8.0

0 commit comments

Comments
 (0)