Skip to content

Commit c1e9759

Browse files
committed
Say 'Template instance' instead of 'object' in docstrings, matching Plotly's phrasing
1 parent 990917f commit c1e9759

3 files changed

Lines changed: 3 additions & 3 deletions

File tree

src/ridgeplot/_ridgeplot.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -403,7 +403,7 @@ def ridgeplot(
403403
The Plotly template to use in this figure. This can be the name of a
404404
registered template (e.g., ``"plotly_dark"``), a
405405
:class:`plotly.graph_objects.layout.Template
406-
<plotly.graph_objs.layout.Template>` object, or a dictionary with a
406+
<plotly.graph_objs.layout.Template>` instance, or a dictionary with a
407407
template's properties. See `Plotly's theming and templates guide`_
408408
for more details. If not specified (default), the plot will be
409409
rendered using Plotly's current default template (i.e.,

src/ridgeplot/_template.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
def validate_coerce_template(template: PlotlyTemplate | None) -> go.layout.Template | None:
1616
"""Convert mixed template representations into a
1717
:class:`plotly.graph_objects.layout.Template
18-
<plotly.graph_objs.layout.Template>` object.
18+
<plotly.graph_objs.layout.Template>` instance.
1919
2020
``None`` is passed through as-is, meaning that no template has been
2121
specified and that Plotly's current default template should be used.

src/ridgeplot/_types.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@
7474
PlotlyTemplate: TypeAlias = go.layout.Template | dict[str, Any] | str
7575
"""A Plotly figure template can be represented by a
7676
:class:`plotly.graph_objects.layout.Template <plotly.graph_objs.layout.Template>`
77-
object, a dictionary with a template's properties, or the name of a registered
77+
instance, a dictionary with a template's properties, or the name of a registered
7878
template (e.g., ``"plotly_dark"``).
7979
8080
See `Plotly's theming and templates guide

0 commit comments

Comments
 (0)