You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: .github/CONTRIBUTING.md
+8-3
Original file line number
Diff line number
Diff line change
@@ -69,15 +69,20 @@ You will find the built documentation in `docs/_build/html`.
69
69
## Code
70
70
71
71
- 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:
73
73
74
74
```python
75
-
deffunc(x: str) -> str:
75
+
deffunc(x: str, y: int) -> str:
76
76
"""
77
77
Do something.
78
78
79
79
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
0 commit comments