{{ function.name }} 🔗

{{ function.filename }}:{{ function.line }}

{% markdown %}{{ function.description }}{% endmarkdown %}

Arguments

{% if function.params|length %} {% for param in function.params %} {% endfor %}

Name	Type	Default value	Description
`{{ param.name }}`	`{{ param.type }}`	{% if param.default_value %} `{{ param.default_value }}` {% else %} `nil` {% endif %}	{% markdown %}{{ param.description }}{% endmarkdown %}

{% else %}

This function takes no arguments.

{% endif %}

Returns

{% if function.returns %} {{ function.returns.type}} {% if function.returns.description %}: {% markdown %}{{ function.returns.description }}{% endmarkdown %}{% endif %} {% else %} nil {% endif %}

{% if function.examples|length %}

Examples

{% for example in function.examples %}

{% endfor %}

{% endif %}

Source

{{function.text}}

{{function|dump("\t")}}

{{ function.name }} 🔗

Arguments

Returns

Examples

{{ example.description }}