--- layout: api title: [[ title ]] ---
[[ prename ]]. [%- if classname %][[ classname ]].[% endif %] [[ name ]] [%- if has_sig %]  (  [%- for p in sig %] [%- if p.star %][[ p.star ]][% endif %][[ p.name ]] [%- if p.default is not none %]=[[ p.default ]][% endif -%] [%- if not loop.last %] ,  [%- endif %] [%- endfor %]  ) [%- endif %][source]
[[ description ]]
[%- if params %]
Parameters:
[%- for p in params %]
[[ p.name ]][% if p.type %][[ p.type ]][% endif %]
[[ p.description ]]
[%- endfor %]
[%- endif %] [%- if attributes %]
Attributes:
[%- for a in attributes %]
[[ a.name ]][% if a.type %][[ a.type ]][% endif %] [%- if a.value is not none %][[ a.value ]][% endif %]
[%- if a.description %]
[[ a.description ]]
[%- endif %] [%- endfor %]
[%- endif %] [%- if returns %]
Returns:
[[ returns.label ]][% if returns.type %][[ returns.type ]][% endif %]
[[ returns.description ]]
[%- endif %] [%- if raises %]
Raises:
[%- for r in raises %]
[[ r.error ]]
[[ r.description ]]
[%- endfor %]
[%- endif %]