synology-api/docstring.mustache at master · N4S4/synology-api · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
{{! 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
    }
    ```