Skip to content

Commit 71ba0f7

Browse files
committed
DOC: Fix formatting in contributors.md [skip ci]
1 parent 9aee8d5 commit 71ba0f7

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

doc/development/contributors.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ on GitHub and filling out the template.
5252

5353
* **Please try to fill out the template with as much detail as you can**.
5454
* After submitting your bug report or feature request,
55-
try to answer any follow up questions as best as you can.
55+
try to answer any follow-up questions as best as you can.
5656

5757
## General Guidelines
5858

@@ -182,30 +182,30 @@ After completing these steps, you are ready for development!
182182

183183
### crowsetta Code Overview
184184

185-
The source code for crowsetta is located in the directory ``./src/crowsetta``. When contributing
185+
The source code for crowsetta is located in the directory `./src/crowsetta`. When contributing
186186
code, be sure to follow the general guidelines in the
187-
:ref:`dev-workflow` section.
187+
{ref}`dev-workflow` section.
188188

189189
### Code Style
190190

191191
In general, crowsetta code should
192192

193-
* follow the `Zen of Python <https://www.python.org/dev/peps/pep-0020/#id2>`_ in terms of implementation
194-
* follow the `PEP8 style guide <https://www.python.org/dev/peps/pep-0008/>`_ for code
195-
* follow the `numpy standard for docstrings <https://numpydoc.readthedocs.io/en/latest/format.html#docstring-standard>`_
193+
* follow the [Zen of Python](https://www.python.org/dev/peps/pep-0020/#id2) in terms of implementation
194+
* follow the [PEP8 style guide](https://www.python.org/dev/peps/pep-0008/) for code
195+
* follow the [numpy standard for docstrings](https://numpydoc.readthedocs.io/en/latest/format.html#docstring-standard)
196196

197-
We also use the tool `Black <https://github.com/psf/black>`_ to format the code, so we don't have to think about it.
197+
We also use the tool [Black](https://github.com/psf/black) to format the code, so we don't have to think about it.
198198

199199
### Testing your Code
200200

201201
Automated testing helps ensure that our code is as free of bugs as it can be.
202202
It also lets us know immediately if a change we make breaks any other part of the code.
203203

204-
All of our test code and data are stored in the directory ``./tests``,
204+
All of our test code and data are stored in the directory `./tests`,
205205
that is set up as if it were a Python package.
206-
We use the `pytest <https://pytest.org>`_ framework to run the test suite.
206+
We use the [pytest](https://pytest.org) framework to run the test suite.
207207
While developing, you can run the entire test suite inside an
208-
activated virtual environment by running ``pytest`` from the command line:
208+
activated virtual environment by running `pytest` from the command line:
209209

210210
```shell
211211
pytest

0 commit comments

Comments
 (0)