mirror of
https://github.com/kristoferssolo/solorice.git
synced 2025-10-21 20:10:34 +00:00
25 lines
579 B
Plaintext
25 lines
579 B
Plaintext
{{! Sphinx Docstring Template }}
|
|
{{summaryPlaceholder}}
|
|
|
|
{{extendedSummaryPlaceholder}}
|
|
|
|
{{#args}}
|
|
:param {{var}}: {{descriptionPlaceholder}}
|
|
:type {{var}}: {{typePlaceholder}}
|
|
{{/args}}
|
|
{{#kwargs}}
|
|
:param {{var}}: {{descriptionPlaceholder}}, defaults to {{&default}}
|
|
:type {{var}}: {{typePlaceholder}}, optional
|
|
{{/kwargs}}
|
|
{{#exceptions}}
|
|
:raises {{type}}: {{descriptionPlaceholder}}
|
|
{{/exceptions}}
|
|
{{#returns}}
|
|
:return: {{descriptionPlaceholder}}
|
|
:rtype: {{typePlaceholder}}
|
|
{{/returns}}
|
|
{{#yields}}
|
|
:yield: {{descriptionPlaceholder}}
|
|
:rtype: {{typePlaceholder}}
|
|
{{/yields}}
|