Skip to content

Commit f792aa0

Browse files
committed
Improve example
1 parent bf88d7b commit f792aa0

1 file changed

Lines changed: 5 additions & 0 deletions

File tree

‎docs/pages/format.rst‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,12 +53,17 @@ Docstrings should be formatted as follows:
5353
"""
5454
This is a function.
5555
56+
Here is more information about the function.
57+
It is separated from the short summary by a blank line.
58+
5659
Parameters
5760
----------
5861
arg1:
5962
This is the first argument.
63+
We skip the type hint inside the docstring.
6064
arg2:
6165
This is the second argument.
66+
We skip the type hint inside the docstring.
6267
6368
Returns/Yields
6469
--------------

0 commit comments

Comments
 (0)