{fn.name}

{#if fn.override_signature}
{fn.override_signature}
{:else}
{fn.parent}.{fn.name}({#each fn.parameters as param}{#if !("kwargs" in param) && !("default" in param) && param.name != "self"}{param.name}, {/if}{/each}ยทยทยท)
{/if}

Description

{@html fn.description}

{#if fn.example}

Example Usage

{@html fn.highlighted_example}
{/if} {#if (fn.parameters.length > 0 && fn.parameters[0].name != "self") || fn.parameters.length > 1}

Agruments

{#each fn.parameters as param} {#if param["name"] != "self"} {/if} {/each}
Parameter Description
{param["name"]}

{param["annotation"]}

{#if "default" in param}

default: {param["default"]}

{:else if !("kwargs" in param)}

required

{/if}

{@html param["doc"] || ""}

{/if}