Skip to content

Commit fe88202

Browse files
committed
Expand docstring example
1 parent 4e22822 commit fe88202

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

.github/CONTRIBUTING.md

+8-3
Original file line numberDiff line numberDiff line change
@@ -69,15 +69,20 @@ You will find the built documentation in `docs/_build/html`.
6969
## Code
7070

7171
- Obey [PEP 8] and [PEP 257].
72-
We use the `"""`-on-separate-lines style for docstrings with [Napoleon](https://www.sphinx-doc.org/en/master/usage/extensions/napoleon.html)-style API documentation:
72+
We use the `"""`-on-separate-lines style for docstrings with [Napoleon]-style API documentation:
7373

7474
```python
75-
def func(x: str) -> str:
75+
def func(x: str, y: int) -> str:
7676
"""
7777
Do something.
7878
7979
Args:
80-
x: A very important parameter.
80+
x: A very important argument.
81+
82+
y:
83+
Another very important argument, but its description is so long
84+
that it doesn't fit on one line. So we start the whole block on a
85+
fresh new line to keep the block together.
8186
8287
Returns:
8388
The result of doing something.

0 commit comments

Comments
 (0)