Created
March 12, 2021 13:58
-
-
Save josepsmartinez/d9e6fdd01d70832fbc7d7095d4673e5f to your computer and use it in GitHub Desktop.
Python docstring template (like gensim and sklearn)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| def foo(): | |
| """<FUNCTION DESCRIPTION> | |
| <BLANK LINE> | |
| Parameters | |
| ---------- | |
| <VARIABLE> : <TYPE> | |
| <DESCRIPTION> | |
| ... | |
| <BLANK LINE> | |
| Returns | |
| ------- | |
| <TYPE> | |
| <DESCRIPTION> | |
| ... | |
| """ | |
| <FUNCTION IMPLEMENTATION> |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment