@@ -52,7 +52,7 @@ on GitHub and filling out the template.
52
52
53
53
* ** Please try to fill out the template with as much detail as you can** .
54
54
* 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.
56
56
57
57
## General Guidelines
58
58
@@ -182,30 +182,30 @@ After completing these steps, you are ready for development!
182
182
183
183
### crowsetta Code Overview
184
184
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
186
186
code, be sure to follow the general guidelines in the
187
- : ref: ` dev-workflow ` section.
187
+ { ref} ` dev-workflow ` section.
188
188
189
189
### Code Style
190
190
191
191
In general, crowsetta code should
192
192
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 )
196
196
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.
198
198
199
199
### Testing your Code
200
200
201
201
Automated testing helps ensure that our code is as free of bugs as it can be.
202
202
It also lets us know immediately if a change we make breaks any other part of the code.
203
203
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 ` ,
205
205
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.
207
207
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:
209
209
210
210
``` shell
211
211
pytest
0 commit comments