45 lines
736 B
Plaintext
45 lines
736 B
Plaintext
{{! Numpy Docstring Template }}
|
|
{{summaryPlaceholder}}
|
|
|
|
{{extendedSummaryPlaceholder}}
|
|
{{#parametersExist}}
|
|
|
|
Parameters
|
|
----------
|
|
{{#args}}
|
|
{{var}} : {{typePlaceholder}}
|
|
{{descriptionPlaceholder}}
|
|
{{/args}}
|
|
{{#kwargs}}
|
|
{{var}} : {{typePlaceholder}}, optional
|
|
{{descriptionPlaceholder}}, by default {{&default}}
|
|
{{/kwargs}}
|
|
{{/parametersExist}}
|
|
{{#returnsExist}}
|
|
|
|
Returns
|
|
-------
|
|
{{#returns}}
|
|
{{typePlaceholder}}
|
|
{{descriptionPlaceholder}}
|
|
{{/returns}}
|
|
{{/returnsExist}}
|
|
{{#yieldsExist}}
|
|
|
|
Yields
|
|
------
|
|
{{#yields}}
|
|
{{typePlaceholder}}
|
|
{{descriptionPlaceholder}}
|
|
{{/yields}}
|
|
{{/yieldsExist}}
|
|
{{#exceptionsExist}}
|
|
|
|
Raises
|
|
------
|
|
{{#exceptions}}
|
|
{{type}}
|
|
{{descriptionPlaceholder}}
|
|
{{/exceptions}}
|
|
{{/exceptionsExist}}
|