36 lines
709 B
Plaintext
36 lines
709 B
Plaintext
{{! Google 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}}
|