{{ obj['override_signature'] }}
{{ parent }}.{{ obj["name"] }}({% for param in obj["parameters"] %}{% if "positional" in param["kind"] and "default" not in param and param["name"] != "self" %}{{ param["name"] }}, {% endif %}{% endfor %}ยทยทยท)
{{ obj["description"] }}
As input: {{ obj["tags"]["preprocessing"] }}
As output: {{ obj["tags"]["postprocessing"] }}
{% if "examples-format" in obj["tags"] %}Format expected for examples: {{ obj["tags"]["examples-format"] }}
{% endif %} {% if obj["events"]|length > 0 %}Supported events: {{ obj["events"] }}
{% endif %} {% endif %} {% if obj["example"] %}{{ obj["example"] }}
Parameter | Description |
---|---|
{{ param["name"] }}
{{ param["annotation"] }} {% if "default" in param %}default: {{ param["default"] }} {% elif "kwargs" not in param %}required {% endif %} |
{{ param["doc"] or "" }} |
Class | Interface String Shortcut | Initialization |
---|---|---|
|
"{{ shortcut }}" |
{{ settings }} |
{{ guide.pretty_name }}
No guides yet, contribute a guide about {{ obj["name"] }}
{% endif %} {% endif %}