Last active
March 26, 2023 11:41
-
-
Save eltrujo/dbde80ff91c83d4e07a2a40fad6aef85 to your computer and use it in GitHub Desktop.
This file contains 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
| {{! Markdown-friendly Docstring Template }} | |
| {{summaryPlaceholder}} | |
| {{#parametersExist}} | |
| ### Parameters | |
| {{#args}} | |
| `{{var}}` : `{{type}}` | |
| {{descriptionPlaceholder}} | |
| {{/args}} | |
| {{#kwargs}} | |
| `{{var}}` : `{{type}}` (by default `{{&default}}`) | |
| {{descriptionPlaceholder}} | |
| {{/kwargs}} | |
| {{/parametersExist}} | |
| {{#exceptionsExist}} | |
| ### Raises | |
| {{#exceptions}} | |
| `{{type}}` : {{descriptionPlaceholder}} | |
| {{/exceptions}} | |
| {{/exceptionsExist}} | |
| {{#returnsExist}} | |
| ### Returns | |
| {{#returns}} | |
| `{{type}}` : {{descriptionPlaceholder}} | |
| {{/returns}} | |
| {{/returnsExist}} | |
| {{#yieldsExist}} | |
| ### Yields | |
| {{#yields}} | |
| `{{type}}` : {{descriptionPlaceholder}} | |
| {{/yields}} | |
| {{/yieldsExist}} |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment