Skip to content

Commit 6194de2

Browse files
committed
some typo cleanup
1 parent 75745e8 commit 6194de2

File tree

2 files changed

+6
-8
lines changed

2 files changed

+6
-8
lines changed

docs/python/docstrings.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -190,9 +190,9 @@ to check that your docstrings render correctly
190190

191191

192192

193-
## Examples
193+
### Examples
194194

195-
### Google Docstrings (recommended)
195+
#### Google Docstrings (recommended)
196196

197197
```python
198198

@@ -495,13 +495,11 @@ class ExampleClass:
495495

496496
```
497497

498-
### ReStructured Text Doc strings
498+
#### ReStructured Text Doc strings
499499

500500
You can see this kind of docstring especially in python libraries.
501501
Please use **Google** style as they are more readable.
502502

503-
##### Examples:
504-
505503
```python
506504
"""The method below prints a given string twice
507505
@@ -606,7 +604,7 @@ This can be tested with:
606604
$python example.py -v
607605
```
608606

609-
## References
607+
### References
610608

611609
Thanks to the following
612610

docs/python/testing.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,6 @@ sidebar_label: Testing
2020
* Always confirm the `schema` when testing Web API response data.
2121
* Passing tests for `merge` should be priority for all projects.
2222
* Tests should always cover:
23-
+ **Unit**: for you code units. Please use `mock` for external dependency and side effects.
24-
+ **Functional**: You program functionality.
23+
+ **Unit**: for your code units. Please use `mock` for external dependency and side effects.
24+
+ **Functional**: Your program functionality.
2525
+ **Integration**: Your whole program integration.

0 commit comments

Comments
 (0)