Skip to content

Commit 0bd2fc6

Browse files
committed
pydocstyle linter typo and test doc addition
1 parent 3e4468c commit 0bd2fc6

File tree

2 files changed

+6
-2
lines changed

2 files changed

+6
-2
lines changed

docs/python/docstrings.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,7 @@ to check that your docstrings render correctly
157157

158158
### Checking Docstring coverage
159159

160-
- Use [pycodestyle](https://pycodestyle.pycqa.org/en/latest/) for linting your code against docstrings. When using `flake8`, [this](https://gitlab.com/pycqa/flake8-docstrings) plugin can be used.
160+
- Use [pydocstyle](https://pydocstyle.pycqa.org/en/latest/) for linting your code against docstrings. When using `flake8`, [this](https://gitlab.com/pycqa/flake8-docstrings) plugin can be used.
161161
- [interrogate](https://interrogate.readthedocs.io/en/latest/) (example below) is **recommended** to use for docstring coverage in the code.
162162

163163

docs/python/testing.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: Testing in python
44
sidebar_label: Testing
55
---
66

7-
### Test is integral part of sofware quality and should not be missed.
7+
#### Test is integral part of sofware quality and should not be missed.
88

99

1010

@@ -19,3 +19,7 @@ sidebar_label: Testing
1919
* `jsonschema` and `genson` like tool can be used for JSON validity.
2020
* Always confirm the `schema` when testing Web API response data.
2121
* Passing tests for `merge` should be priority for all projects.
22+
* Tests should always cover:
23+
+ **Unit**: for you code units. Please use `mock` for external dependency and side effects.
24+
+ **Functional**: You program functionality.
25+
+ **Integration**: Your whole program integration.

0 commit comments

Comments
 (0)