Fix example docstring example in CONTRIBUTING.md
This commit is contained in:
parent
18e5f80105
commit
26b893b38c
1 changed files with 1 additions and 2 deletions
|
|
@ -77,8 +77,7 @@ For function arguments, return values, and exceptions we use the following style
|
||||||
|
|
||||||
```python
|
```python
|
||||||
def a_function(arg1: str, arg2: int) -> tuple[float, int]:
|
def a_function(arg1: str, arg2: int) -> tuple[float, int]:
|
||||||
"""
|
"""A one sentence summary, in imperative mood, ending with punctuation.
|
||||||
A one sentence summary, in imperative mood, ending with punctuation.
|
|
||||||
|
|
||||||
More detail after a blank line. This could be a whole paragraph.
|
More detail after a blank line. This could be a whole paragraph.
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue