Created
November 10, 2021 08:55
-
-
Save takotab/8e23c2241a7d158a165380c37330f45c 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
| {{! FastAPI Docstring Template }} | |
| {{summaryPlaceholder}} | |
| {{extendedSummaryPlaceholder}} | |
| ``` | |
| {{#parametersExist}} | |
| Args: | |
| {{#args}} | |
| {{var}} ({{typePlaceholder}}): {{descriptionPlaceholder}} | |
| {{/args}} | |
| {{#kwargs}} | |
| {{var}} ({{typePlaceholder}}, optional): {{descriptionPlaceholder}}. Defaults to {{&default}}. | |
| {{/kwargs}} | |
| {{/parametersExist}} | |
| {{#exceptionsExist}} | |
| Raises: | |
| {{#exceptions}} | |
| {{type}}: {{descriptionPlaceholder}} | |
| {{/exceptions}} | |
| {{/exceptionsExist}} | |
| {{#returnsExist}} | |
| Returns: | |
| {{#returns}} | |
| {{typePlaceholder}}: {{descriptionPlaceholder}} | |
| {{/returns}} | |
| {{/returnsExist}} | |
| {{#yieldsExist}} | |
| Yields: | |
| {{#yields}} | |
| {{typePlaceholder}}: {{descriptionPlaceholder}} | |
| {{/yields}} | |
| {{/yieldsExist}} | |
| ``` |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment