Skip to content

Commit 7660bd9

Browse files
committed
Update formatting of contributing guide.
1 parent c6ce383 commit 7660bd9

File tree

5 files changed

+20
-10
lines changed

5 files changed

+20
-10
lines changed

repo_helper/templates/CONTRIBUTING.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@ Contributing
44

55
.. This file based on https://github.com/PyGithub/PyGithub/blob/master/CONTRIBUTING.md
66
7-
``{{ modname }}`` uses `tox <https://tox.readthedocs.io>`_ to automate testing and packaging, and `pre-commit <https://pre-commit.com>`_ to maintain code quality.
7+
``{{ modname }}`` uses `tox <https://tox.readthedocs.io>`_ to automate testing and packaging,
8+
and `pre-commit <https://pre-commit.com>`_ to maintain code quality.
89

910
Install ``pre-commit`` with ``pip`` and install the git hook:
1011

@@ -26,7 +27,8 @@ Or, to run the complete autoformatting suite:
2627
Automated tests
2728
-------------------
2829

29-
Tests are run with ``tox`` and ``pytest``. To run tests for a specific Python version, such as Python 3.6, run:
30+
Tests are run with ``tox`` and ``pytest``.
31+
To run tests for a specific Python version, such as Python 3.6:
3032

3133
{{ bash_block("tox -e py36") }}
3234

tests/test_files/test_contributing_/test_make_contributing.html

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
<p><tt><span class="pre">hello-world</span></tt> uses <a href="https://tox.readthedocs.io" rel="nofollow">tox</a> to automate testing and packaging, and <a href="https://pre-commit.com" rel="nofollow">pre-commit</a> to maintain code quality.</p>
1+
<p><tt><span class="pre">hello-world</span></tt> uses <a href="https://tox.readthedocs.io" rel="nofollow">tox</a> to automate testing and packaging,
2+
and <a href="https://pre-commit.com" rel="nofollow">pre-commit</a> to maintain code quality.</p>
23
<p>Install <tt><span class="pre">pre-commit</span></tt> with <tt>pip</tt> and install the git hook:</p>
34
<pre>$ python -m pip install pre-commit
45
$ pre-commit install
@@ -15,7 +16,8 @@ <h2>Coding style</h2>
1516
</div>
1617
<div id="automated-tests">
1718
<h2>Automated tests</h2>
18-
<p>Tests are run with <tt>tox</tt> and <tt>pytest</tt>. To run tests for a specific Python version, such as Python 3.6, run:</p>
19+
<p>Tests are run with <tt>tox</tt> and <tt>pytest</tt>.
20+
To run tests for a specific Python version, such as Python 3.6:</p>
1921
<pre>$ tox -e py36
2022
</pre>
2123
<p>To run tests for all Python versions, simply run:</p>

tests/test_files/test_contributing_/test_make_contributing.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@ Contributing
44

55
.. This file based on https://github.com/PyGithub/PyGithub/blob/master/CONTRIBUTING.md
66
7-
``hello-world`` uses `tox <https://tox.readthedocs.io>`_ to automate testing and packaging, and `pre-commit <https://pre-commit.com>`_ to maintain code quality.
7+
``hello-world`` uses `tox <https://tox.readthedocs.io>`_ to automate testing and packaging,
8+
and `pre-commit <https://pre-commit.com>`_ to maintain code quality.
89

910
Install ``pre-commit`` with ``pip`` and install the git hook:
1011

@@ -36,7 +37,8 @@ Or, to run the complete autoformatting suite:
3637
Automated tests
3738
-------------------
3839

39-
Tests are run with ``tox`` and ``pytest``. To run tests for a specific Python version, such as Python 3.6, run:
40+
Tests are run with ``tox`` and ``pytest``.
41+
To run tests for a specific Python version, such as Python 3.6:
4042

4143
.. code-block:: bash
4244

tests/test_files/test_contributing_/test_make_docs_contributing_False_.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@ Overview
33

44
.. This file based on https://github.com/PyGithub/PyGithub/blob/master/CONTRIBUTING.md
55
6-
``hello-world`` uses `tox <https://tox.readthedocs.io>`_ to automate testing and packaging, and `pre-commit <https://pre-commit.com>`_ to maintain code quality.
6+
``hello-world`` uses `tox <https://tox.readthedocs.io>`_ to automate testing and packaging,
7+
and `pre-commit <https://pre-commit.com>`_ to maintain code quality.
78

89
Install ``pre-commit`` with ``pip`` and install the git hook:
910

@@ -35,7 +36,8 @@ Or, to run the complete autoformatting suite:
3536
Automated tests
3637
-------------------
3738

38-
Tests are run with ``tox`` and ``pytest``. To run tests for a specific Python version, such as Python 3.6, run:
39+
Tests are run with ``tox`` and ``pytest``.
40+
To run tests for a specific Python version, such as Python 3.6:
3941

4042
.. prompt:: bash
4143

tests/test_files/test_contributing_/test_make_docs_contributing_True_.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@ Contributing
44

55
.. This file based on https://github.com/PyGithub/PyGithub/blob/master/CONTRIBUTING.md
66
7-
``hello-world`` uses `tox <https://tox.readthedocs.io>`_ to automate testing and packaging, and `pre-commit <https://pre-commit.com>`_ to maintain code quality.
7+
``hello-world`` uses `tox <https://tox.readthedocs.io>`_ to automate testing and packaging,
8+
and `pre-commit <https://pre-commit.com>`_ to maintain code quality.
89

910
Install ``pre-commit`` with ``pip`` and install the git hook:
1011

@@ -36,7 +37,8 @@ Or, to run the complete autoformatting suite:
3637
Automated tests
3738
-------------------
3839

39-
Tests are run with ``tox`` and ``pytest``. To run tests for a specific Python version, such as Python 3.6, run:
40+
Tests are run with ``tox`` and ``pytest``.
41+
To run tests for a specific Python version, such as Python 3.6:
4042

4143
.. prompt:: bash
4244

0 commit comments

Comments
 (0)