Skip to content

Commit 02b9633

Browse files
Copilotalexlib
andauthored
docs: clarify OpenPIV GPU clone and test command examples
Agent-Logs-Url: https://github.com/OpenPIV/openpiv-python-gpu/sessions/85a079ee-bcfa-44d2-92f9-cafc65f2743f Co-authored-by: alexlib <747110+alexlib@users.noreply.github.com>
1 parent 348e00d commit 02b9633

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

‎openpiv/docs/src/developers.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ This is absolutely not a comprehensive guide of git development, and it is only
1414

1515
1) Download and install git. Instruction can be found `here <http://help.github.com/>`_.
1616
2) Set up a github account.
17-
3) Clone this repository using::
17+
3) Clone the OpenPIV GPU repository using::
1818

1919
git clone https://github.com/OpenPIV/openpiv-python-gpu.git
2020
@@ -37,7 +37,7 @@ validated.
3737
Before opening the PR, run at least:
3838

3939
* GPU tutorial notebook(s) on Colab or another CUDA-enabled environment.
40-
* ``python -m pytest openpiv/test/gpu`` from the repository root on a CUDA-enabled machine.
40+
* ``python -m pytest openpiv/test`` on a CUDA-enabled machine (includes the GPU tests under ``openpiv/test/gpu``).
4141
* Relevant CPU regression tests, e.g. ``python -m pytest openpiv/test/test_validation.py``.
4242

4343
API compatibility note: avoid renaming public functions or changing public arguments without a compatibility plan.

0 commit comments

Comments
 (0)