mirror of
https://github.com/N4S4/synology-api.git
synced 2025-07-22 12:08:56 +00:00
91c82f9aa1
Original value "Example return" is not supported by numpydocs-validation for python. https://numpydoc.readthedocs.io/en/latest/format.html#examples An optional section for examples, using the doctest format.
36 lines
713 B
Plaintext
36 lines
713 B
Plaintext
{{! Numpy Docstring Template }}
|
|
{{summaryPlaceholder}}
|
|
{{#parametersExist}}
|
|
|
|
Parameters
|
|
----------
|
|
{{#args}}
|
|
{{var}} : {{typePlaceholder}}
|
|
{{descriptionPlaceholder}}
|
|
{{/args}}
|
|
{{#kwargs}}
|
|
{{var}} : {{typePlaceholder}}, optional
|
|
{{descriptionPlaceholder}}. Defaults to `{{&default}}`
|
|
{{/kwargs}}
|
|
{{/parametersExist}}
|
|
{{#returnsExist}}
|
|
|
|
Returns
|
|
-------
|
|
{{#returns}}
|
|
{{typePlaceholder}}
|
|
{{descriptionPlaceholder}}
|
|
{{/returns}}
|
|
{{/returnsExist}}
|
|
|
|
Example
|
|
----------
|
|
```json
|
|
{
|
|
"data": {
|
|
"template": "data"
|
|
},
|
|
"success": true
|
|
}
|
|
```
|