Skip to content

[doc] Update docs on parameter packs #3646

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
vkarak merged 1 commit into from
Apr 2, 2026
+3 −2
Merged

[doc] Update docs on parameter packs #3646

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions docs/tutorial.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -969,7 +969,8 @@ Instead of the skip hook, we simply unpack the combined parameters in the :func:
:caption:
:pyobject: echo_test_v1

The advantage of using parameter packs instead of skipping explicitly the test is that we do not get a warning message and the test is more compact.
The advantage of using parameter packs instead of skipping the test in a hook is that the test is instantiated only as many times as needed.
If only few parameter combinations are valid, then parameter packs can speed up test loading.

.. note::

Expand Down Expand Up @@ -1532,7 +1533,7 @@ Here is an example:
.. code-block:: python

from reframe.core.builtins import xfail

reference = {
'tutorialsys': {
'copy_bw': xfail('demo fail', (100_000, -0.1, 0.1, 'MB/s')),
Expand Down
Loading