Skip to content
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.

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

[Docs] : updated the pytest arg from --regression-data to --tardis-regression-data #2982

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 3 additions & 1 deletion .mailmap
Original file line number Diff line number Diff line change
Expand Up @@ -289,4 +289,6 @@ Israel Roldan <[email protected]> airv_zxf <[email protected]

Michael Zingale <[email protected]>

Akash Kaushik <[email protected]>
Akash Kaushik <[email protected]>

Rudraksh Nalbalwar <[email protected]>
4 changes: 2 additions & 2 deletions docs/contributing/development/update_regression_data.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
Update the Regression Data
*************************

A special kind of tests are executed only when ``pytest`` is called alongside the ``--regression-data`` flag. These tests compare the output of the TARDIS code (mostly arrays) against the information stored in the regression data files.
A special kind of tests are executed only when ``pytest`` is called alongside the ``--tardis-regression-data`` flag. These tests compare the output of the TARDIS code (mostly arrays) against the information stored in the regression data files.

TARDIS stores regression data in the `tardis-regression-data <https://github.com/tardis-sn/tardis-regression-data>`_ repository. Sometimes, this data needs to be updated. The procedure to update these files has been simplified, allowing for a more straightforward process.

Expand All @@ -20,7 +20,7 @@ If you suspect scenario B, please follow these instructions:
#. Fork and clone the ``tardis-regression-data`` repository.
#. Follow any necessary instructions within your local copy.
#. Go to your local ``tardis`` repository and ensure you are working on the branch from which you want to generate new regression data.
#. Generate new regression data with ``pytest tardis --regression-data=/path/to/tardis-regression-data --generate-reference``.
#. Generate new regression data with ``pytest tardis --tardis-regression-data=/path/to/tardis-regression-data --generate-reference``.
#. Check your results and ensure everything is correct.
#. Make a new branch in ``tardis-regression-data``, push your new regression data, and open a pull request.

Expand Down
Loading