dotfiles/vscode/.vscode/extensions/njpwerner.autodocstring-0.6.1/docs/docblockr.md
Errol Sancaktar ff17c17e23 vscode
2024-06-14 09:31:58 -06:00

28 lines
478 B
Markdown

# docBlockr Docstring Format
```python
def abc(a: int, c = [1,2]):
"""_summary_
Arguments:
a {int} -- _description_
Keyword Arguments:
c {list} -- _description_ (default: {[1,2]})
Raises:
AssertionError: _description_
Returns:
_type_ -- _description_
"""
if a > 10:
raise AssertionError("a is more than 10")
return c
if a > 10:
raise AssertionError("a is more than 10")
return c
```