21 lines
529 B
Plaintext
21 lines
529 B
Plaintext
{{! One-line RST Docstring Template }}
|
|
{{summaryPlaceholder}}
|
|
|
|
{{extendedSummaryPlaceholder}}
|
|
|
|
{{#args}}
|
|
:param {{typePlaceholder}} {{var}}: {{descriptionPlaceholder}}
|
|
{{/args}}
|
|
{{#kwargs}}
|
|
:param {{typePlaceholder}} {{var}}: {{descriptionPlaceholder}}, defaults to {{&default}}
|
|
{{/kwargs}}
|
|
{{#exceptions}}
|
|
:raises {{type}}: {{descriptionPlaceholder}}
|
|
{{/exceptions}}
|
|
{{#returns}}
|
|
:return {{typePlaceholder}}: {{descriptionPlaceholder}}
|
|
{{/returns}}
|
|
{{#yields}}
|
|
:yield {{typePlaceholder}}: {{descriptionPlaceholder}}
|
|
{{/yields}}
|