Skip to content

Commit 6d61f41

Browse files
committed
Updated contributing guide.
1 parent 344b9ae commit 6d61f41

File tree

2 files changed

+8
-10
lines changed

2 files changed

+8
-10
lines changed

CONTRIBUTING.rst

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,17 +17,16 @@ Install ``pre-commit`` with ``pip`` and install the git hook:
1717
Coding style
1818
--------------
1919

20-
`Yapf <https://github.com/google/yapf>`_ is used for code formatting, and `isort <https://timothycrosley.github.io/isort/>`_ is used to sort imports.
20+
`yapf-isort <https://pypi.org/project/yapf-isort/>`_ is used for code formatting.
2121

22-
``yapf`` and ``isort`` can be run manually via ``pre-commit``:
22+
It can be run manually via ``pre-commit``:
2323

2424
.. code-block:: bash
2525
26-
$ pre-commit run yapf -a
27-
$ pre-commit run isort -a
26+
$ pre-commit run yapf-isort -a
2827
2928
30-
The complete autoformatting suite can be run with ``pre-commit``:
29+
Or, to run the complete autoformatting suite:
3130

3231
.. code-block:: bash
3332

doc-source/contributing.rst

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,17 +16,16 @@ Install ``pre-commit`` with ``pip`` and install the git hook:
1616
Coding style
1717
--------------
1818

19-
`Yapf <https://github.com/google/yapf>`_ is used for code formatting, and `isort <https://timothycrosley.github.io/isort/>`_ is used to sort imports.
19+
`yapf-isort <https://pypi.org/project/yapf-isort/>`_ is used for code formatting.
2020

21-
``yapf`` and ``isort`` can be run manually via ``pre-commit``:
21+
It can be run manually via ``pre-commit``:
2222

2323
.. prompt:: bash
2424

25-
pre-commit run yapf -a
26-
pre-commit run isort -a
25+
pre-commit run yapf-isort -a
2726

2827

29-
The complete autoformatting suite can be run with ``pre-commit``:
28+
Or, to run the complete autoformatting suite:
3029

3130
.. prompt:: bash
3231

0 commit comments

Comments
 (0)