From 26e8a2e16910722ef603a0d10aa238b17514f1d8 Mon Sep 17 00:00:00 2001 From: Rudraksh Nalbalwar Date: Wed, 19 Feb 2025 22:15:49 +0530 Subject: [PATCH] updated the pytest arg from --regression-data to --tardis-regression-data --- .mailmap | 4 +++- docs/contributing/development/update_regression_data.rst | 4 ++-- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/.mailmap b/.mailmap index b238be626b3..e04807970df 100644 --- a/.mailmap +++ b/.mailmap @@ -289,4 +289,6 @@ Israel Roldan airv_zxf -Akash Kaushik \ No newline at end of file +Akash Kaushik + +Rudraksh Nalbalwar diff --git a/docs/contributing/development/update_regression_data.rst b/docs/contributing/development/update_regression_data.rst index 078726e71c0..46e6d355dc2 100644 --- a/docs/contributing/development/update_regression_data.rst +++ b/docs/contributing/development/update_regression_data.rst @@ -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 `_ repository. Sometimes, this data needs to be updated. The procedure to update these files has been simplified, allowing for a more straightforward process. @@ -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.