mirror of
https://github.com/kristoferssolo/solorice.git
synced 2025-10-21 20:10:34 +00:00
24 lines
373 B
Markdown
24 lines
373 B
Markdown
# Pep257 Docstring Format
|
|
|
|
```python
|
|
def abc(a: int, c = [1,2]):
|
|
"""_summary_
|
|
|
|
Arguments:
|
|
a -- _description_
|
|
|
|
Keyword Arguments:
|
|
c -- _description_ (default: {[1,2]})
|
|
|
|
Raises:
|
|
AssertionError: _description_
|
|
|
|
Returns:
|
|
_description_
|
|
"""
|
|
if a > 10:
|
|
raise AssertionError("a is more than 10")
|
|
|
|
return c
|
|
```
|