Skip to content

Commit 75a3b90

Browse files
committed
doc: adapt contributing to uv
1 parent 1a0f98c commit 75a3b90

1 file changed

Lines changed: 48 additions & 9 deletions

File tree

docs/source/contributing.rst

Lines changed: 48 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -66,33 +66,72 @@ Now you can make your changes locally.
6666
:ref:`addingoperator` or :ref:`addingsolver` and that both old and new tests pass
6767
successfully:
6868

69-
.. code-block:: bash
69+
.. tab-set::
70+
71+
.. tab-item:: conda
72+
73+
.. code-block:: bash
74+
75+
>> make tests
76+
77+
.. tab-item:: :iconify:`material-icon-theme:uv` uv
78+
79+
.. code-block:: bash
7080
71-
>> make tests
81+
>> make tests_uv
7282
7383
If you have access to a GPU, it is advised also that old and new tests run with the CuPy
7484
backend pass successfully:
7585

76-
.. code-block:: bash
86+
.. tab-set::
87+
88+
.. tab-item:: conda
7789

78-
>> make tests_gpu
90+
.. code-block:: bash
7991
80-
4. Run flake8 to check the quality of your code:
92+
>> make tests_gpu
8193
82-
.. code-block:: bash
94+
.. tab-item:: :iconify:`material-icon-theme:uv` uv
95+
96+
.. code-block:: bash
97+
98+
>> make tests_gpu_uv
99+
100+
4. Run ruff to check the quality of your code:
83101

84-
>> make lint
102+
.. tab-set::
103+
104+
.. tab-item:: conda
105+
106+
.. code-block:: bash
107+
108+
>> make typeannot
109+
110+
.. tab-item:: :iconify:`material-icon-theme:uv` uv
111+
112+
.. code-block:: bash
113+
114+
>> make typeannot_uv
85115
86116
Note that PyLops does not enforce full compliance with flake8, rather this is used as a
87117
guideline and will also be run as part of our CI.
88118
Make sure to limit to a minimum flake8 warnings before making a PR.
89119

90120
5. Update the docs
91121

92-
.. code-block:: bash
122+
.. tab-set::
123+
124+
.. tab-item:: conda
125+
126+
.. code-block:: bash
127+
128+
>> make docupdate
129+
130+
.. tab-item:: :iconify:`material-icon-theme:uv` uv
93131

94-
>> make docupdate
132+
.. code-block:: bash
95133
134+
>> make docupdate_uv
96135
97136
6. Commit your changes and push your branch to GitHub:
98137

0 commit comments

Comments
 (0)