mirror of
https://github.com/kristoferssolo/solorice.git
synced 2025-10-21 20:10:34 +00:00
29 lines
422 B
Markdown
29 lines
422 B
Markdown
# Numpy Docstring Format
|
|
|
|
```python
|
|
def abc(a: int, c = [1,2]):
|
|
"""_summary_
|
|
|
|
Parameters
|
|
----------
|
|
a : int
|
|
_description_
|
|
c : list, optional
|
|
_description_, by default [1,2]
|
|
|
|
Returns
|
|
-------
|
|
_type_
|
|
_description_
|
|
|
|
Raises
|
|
------
|
|
AssertionError
|
|
_description_
|
|
"""
|
|
if a > 10:
|
|
raise AssertionError("a is more than 10")
|
|
|
|
return c
|
|
```
|