Skip to content

doc: typos #5347

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed

doc: typos #5347

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5373c84
Minor Typo
joshuamarkovic Sep 9, 2025
8f2ef77
Typo
joshuamarkovic Sep 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions codegen/resources/plot-schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47008,7 +47008,7 @@
"editType": "calc",
"role": "object",
"side": {
"description": "Determines on which side of the the treemap the `pathbar` should be presented.",
"description": "Determines on which side of the treemap the `pathbar` should be presented.",
"dflt": "top",
"editType": "plot",
"valType": "enumerated",
Expand Down Expand Up @@ -64477,7 +64477,7 @@
},
"hovertext": {
"arrayOk": true,
"description": "Sets hover text elements associated with each (a,b) point. If a single string, the same string appears over all the data points. If an array of strings, the items are mapped in order to the the data points in (a,b). To be seen, trace `hoverinfo` must contain a *text* flag.",
"description": "Sets hover text elements associated with each (a,b) point. If a single string, the same string appears over all the data points. If an array of strings, the items are mapped in order of the data points in (a,b). To be seen, trace `hoverinfo` must contain a *text* flag.",
"dflt": "",
"editType": "style",
"valType": "string"
Expand Down Expand Up @@ -66186,7 +66186,7 @@
},
"text": {
"arrayOk": true,
"description": "Sets text elements associated with each (a,b) point. If a single string, the same string appears over all the data points. If an array of strings, the items are mapped in order to the the data points in (a,b). If trace `hoverinfo` contains a *text* flag and *hovertext* is not set, these elements will be seen in the hover labels.",
"description": "Sets text elements associated with each (a,b) point. If a single string, the same string appears over all the data points. If an array of strings, the items are mapped in order of the data points in (a,b). If trace `hoverinfo` contains a *text* flag and *hovertext* is not set, these elements will be seen in the hover labels.",
"dflt": "",
"editType": "calc",
"valType": "string"
Expand Down Expand Up @@ -81356,7 +81356,7 @@
},
"hovertext": {
"arrayOk": true,
"description": "Sets hover text elements associated with each (a,b,c) point. If a single string, the same string appears over all the data points. If an array of strings, the items are mapped in order to the the data points in (a,b,c). To be seen, trace `hoverinfo` must contain a *text* flag.",
"description": "Sets hover text elements associated with each (a,b,c) point. If a single string, the same string appears over all the data points. If an array of strings, the items are mapped in order of the data points in (a,b,c). To be seen, trace `hoverinfo` must contain a *text* flag.",
"dflt": "",
"editType": "style",
"valType": "string"
Expand Down Expand Up @@ -83078,7 +83078,7 @@
},
"text": {
"arrayOk": true,
"description": "Sets text elements associated with each (a,b,c) point. If a single string, the same string appears over all the data points. If an array of strings, the items are mapped in order to the the data points in (a,b,c). If trace `hoverinfo` contains a *text* flag and *hovertext* is not set, these elements will be seen in the hover labels.",
"description": "Sets text elements associated with each (a,b,c) point. If a single string, the same string appears over all the data points. If an array of strings, the items are mapped in order of the data points in (a,b,c). If trace `hoverinfo` contains a *text* flag and *hovertext* is not set, these elements will be seen in the hover labels.",
"dflt": "",
"editType": "calc",
"valType": "string"
Expand Down Expand Up @@ -93092,7 +93092,7 @@
"editType": "calc",
"role": "object",
"side": {
"description": "Determines on which side of the the treemap the `pathbar` should be presented.",
"description": "Determines on which side of the treemap the `pathbar` should be presented.",
"dflt": "top",
"editType": "plot",
"valType": "enumerated",
Expand Down
2 changes: 1 addition & 1 deletion doc/python/carpet-plot.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ fig.show()
### Cheater plot layout


The layout of cheater plots is not unique and depends upon the `cheaterslope` and axis `cheatertype` parameters. If `x` is not specified, each row of the `x` array is constructed based on the the formula `a + cheaterslope * b`, where `a` and `b` are either the value or the integer index of `a` and `b` respectively, depending on the corresponding axis `cheatertype`. Although the layout of the axis below is different than the plots above, it represents the same data as the axes above.
The layout of cheater plots is not unique and depends upon the `cheaterslope` and axis `cheatertype` parameters. If `x` is not specified, each row of the `x` array is constructed based on the formula `a + cheaterslope * b`, where `a` and `b` are either the value or the integer index of `a` and `b` respectively, depending on the corresponding axis `cheatertype`. Although the layout of the axis below is different than the plots above, it represents the same data as the axes above.

```python
import plotly.graph_objects as go
Expand Down
2 changes: 1 addition & 1 deletion doc/python/parallel-categories-diagram.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ fig.show()

#### Multi-Color Parallel Categories Diagram

The color of the ribbons can be specified with the `line.color` property. Similar to other trace types, this property may be set to an array of numbers, which are then mapped to colors according to the the colorscale specified in the `line.colorscale` property.
The color of the ribbons can be specified with the `line.color` property. Similar to other trace types, this property may be set to an array of numbers, which are then mapped to colors according to the colorscale specified in the `line.colorscale` property.

Here is an example of visualizing the survival rate of passengers in the titanic dataset, where the ribbons are colored based on survival outcome.

Expand Down
2 changes: 1 addition & 1 deletion doc/python/selections.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ fig.show()
## Referencing Selections on Multiple Cartesian Subplots


You can add selections to multiple Cartesian subplots by specifying `xref` and/or `yref`. Here, we add one selection on the plot with axis ids `x` and `y2` and two selections to the the plot with axis ids `x` and `y`.
You can add selections to multiple Cartesian subplots by specifying `xref` and/or `yref`. Here, we add one selection on the plot with axis ids `x` and `y2` and two selections to the plot with axis ids `x` and `y`.

```python
import plotly.graph_objects as go
Expand Down
2 changes: 1 addition & 1 deletion doc/python/text-and-annotations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@ fig.show()

### Controlling Maximum Text Size

The `textfont_size` parameter of the the [pie](/python/pie-charts), [bar](/python/bar-charts)-like, [sunburst](/python/sunburst-charts) and [treemap](/python/treemaps) traces can be used to set the **maximum font size** used in the chart. Note that the `textfont` parameter sets the `insidetextfont` and `outsidetextfont` parameter, which can also be set independently.
The `textfont_size` parameter of the [pie](/python/pie-charts), [bar](/python/bar-charts)-like, [sunburst](/python/sunburst-charts) and [treemap](/python/treemaps) traces can be used to set the **maximum font size** used in the chart. Note that the `textfont` parameter sets the `insidetextfont` and `outsidetextfont` parameter, which can also be set independently.

```python
import plotly.express as px
Expand Down
8 changes: 4 additions & 4 deletions plotly/graph_objs/_figure.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14026,7 +14026,7 @@ def add_scattercarpet(
Sets hover text elements associated with each (a,b)
point. If a single string, the same string appears over
all the data points. If an array of strings, the items
are mapped in order to the the data points in (a,b). To
are mapped in order of the data points in (a,b). To
be seen, trace `hoverinfo` must contain a "text" flag.
hovertextsrc
Sets the source reference on Chart Studio Cloud for
Expand Down Expand Up @@ -14119,7 +14119,7 @@ def add_scattercarpet(
Sets text elements associated with each (a,b) point. If
a single string, the same string appears over all the
data points. If an array of strings, the items are
mapped in order to the the data points in (a,b). If
mapped in order of the data points in (a,b). If
trace `hoverinfo` contains a "text" flag and
"hovertext" is not set, these elements will be seen in
the hover labels.
Expand Down Expand Up @@ -17391,7 +17391,7 @@ def add_scatterternary(
Sets hover text elements associated with each (a,b,c)
point. If a single string, the same string appears over
all the data points. If an array of strings, the items
are mapped in order to the the data points in (a,b,c).
are mapped in order of the data points in (a,b,c).
To be seen, trace `hoverinfo` must contain a "text"
flag.
hovertextsrc
Expand Down Expand Up @@ -17497,7 +17497,7 @@ def add_scatterternary(
Sets text elements associated with each (a,b,c) point.
If a single string, the same string appears over all
the data points. If an array of strings, the items are
mapped in order to the the data points in (a,b,c). If
mapped in order of the data points in (a,b,c). If
trace `hoverinfo` contains a "text" flag and
"hovertext" is not set, these elements will be seen in
the hover labels.
Expand Down
8 changes: 4 additions & 4 deletions plotly/graph_objs/_figurewidget.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14028,7 +14028,7 @@ def add_scattercarpet(
Sets hover text elements associated with each (a,b)
point. If a single string, the same string appears over
all the data points. If an array of strings, the items
are mapped in order to the the data points in (a,b). To
are mapped in order of the data points in (a,b). To
be seen, trace `hoverinfo` must contain a "text" flag.
hovertextsrc
Sets the source reference on Chart Studio Cloud for
Expand Down Expand Up @@ -14121,7 +14121,7 @@ def add_scattercarpet(
Sets text elements associated with each (a,b) point. If
a single string, the same string appears over all the
data points. If an array of strings, the items are
mapped in order to the the data points in (a,b). If
mapped in order of the data points data points in (a,b). If
trace `hoverinfo` contains a "text" flag and
"hovertext" is not set, these elements will be seen in
the hover labels.
Expand Down Expand Up @@ -17393,7 +17393,7 @@ def add_scatterternary(
Sets hover text elements associated with each (a,b,c)
point. If a single string, the same string appears over
all the data points. If an array of strings, the items
are mapped in order to the the data points in (a,b,c).
are mapped in order of the data points data points in (a,b,c).
To be seen, trace `hoverinfo` must contain a "text"
flag.
hovertextsrc
Expand Down Expand Up @@ -17499,7 +17499,7 @@ def add_scatterternary(
Sets text elements associated with each (a,b,c) point.
If a single string, the same string appears over all
the data points. If an array of strings, the items are
mapped in order to the the data points in (a,b,c). If
mapped in order of the data points in (a,b,c). If
trace `hoverinfo` contains a "text" flag and
"hovertext" is not set, these elements will be seen in
the hover labels.
Expand Down
12 changes: 6 additions & 6 deletions plotly/graph_objs/_scattercarpet.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -417,7 +417,7 @@ def hovertext(self):
Sets hover text elements associated with each (a,b) point. If a
single string, the same string appears over all the data
points. If an array of strings, the items are mapped in order
to the the data points in (a,b). To be seen, trace `hoverinfo`
of the data points in (a,b). To be seen, trace `hoverinfo`
must contain a "text" flag.

The 'hovertext' property is a string and must be specified as:
Expand Down Expand Up @@ -830,7 +830,7 @@ def text(self):
Sets text elements associated with each (a,b) point. If a
single string, the same string appears over all the data
points. If an array of strings, the items are mapped in order
to the the data points in (a,b). If trace `hoverinfo` contains
of the data points in (a,b). If trace `hoverinfo` contains
a "text" flag and "hovertext" is not set, these elements will
be seen in the hover labels.

Expand Down Expand Up @@ -1239,7 +1239,7 @@ def _prop_descriptions(self):
Sets hover text elements associated with each (a,b)
point. If a single string, the same string appears over
all the data points. If an array of strings, the items
are mapped in order to the the data points in (a,b). To
are mapped in order of the data points in (a,b). To
be seen, trace `hoverinfo` must contain a "text" flag.
hovertextsrc
Sets the source reference on Chart Studio Cloud for
Expand Down Expand Up @@ -1332,7 +1332,7 @@ def _prop_descriptions(self):
Sets text elements associated with each (a,b) point. If
a single string, the same string appears over all the
data points. If an array of strings, the items are
mapped in order to the the data points in (a,b). If
mapped in order of the data points in (a,b). If
trace `hoverinfo` contains a "text" flag and
"hovertext" is not set, these elements will be seen in
the hover labels.
Expand Down Expand Up @@ -1573,7 +1573,7 @@ def __init__(
Sets hover text elements associated with each (a,b)
point. If a single string, the same string appears over
all the data points. If an array of strings, the items
are mapped in order to the the data points in (a,b). To
are mapped in order of the data points in (a,b). To
be seen, trace `hoverinfo` must contain a "text" flag.
hovertextsrc
Sets the source reference on Chart Studio Cloud for
Expand Down Expand Up @@ -1666,7 +1666,7 @@ def __init__(
Sets text elements associated with each (a,b) point. If
a single string, the same string appears over all the
data points. If an array of strings, the items are
mapped in order to the the data points in (a,b). If
mapped in order of the data points in (a,b). If
trace `hoverinfo` contains a "text" flag and
"hovertext" is not set, these elements will be seen in
the hover labels.
Expand Down
12 changes: 6 additions & 6 deletions plotly/graph_objs/_scatterternary.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -463,7 +463,7 @@ def hovertext(self):
Sets hover text elements associated with each (a,b,c) point. If
a single string, the same string appears over all the data
points. If an array of strings, the items are mapped in order
to the the data points in (a,b,c). To be seen, trace
of the data points in (a,b,c). To be seen, trace
`hoverinfo` must contain a "text" flag.

The 'hovertext' property is a string and must be specified as:
Expand Down Expand Up @@ -921,7 +921,7 @@ def text(self):
Sets text elements associated with each (a,b,c) point. If a
single string, the same string appears over all the data
points. If an array of strings, the items are mapped in order
to the the data points in (a,b,c). If trace `hoverinfo`
of the data points in (a,b,c). If trace `hoverinfo`
contains a "text" flag and "hovertext" is not set, these
elements will be seen in the hover labels.

Expand Down Expand Up @@ -1283,7 +1283,7 @@ def _prop_descriptions(self):
Sets hover text elements associated with each (a,b,c)
point. If a single string, the same string appears over
all the data points. If an array of strings, the items
are mapped in order to the the data points in (a,b,c).
are mapped in order of the data points in (a,b,c).
To be seen, trace `hoverinfo` must contain a "text"
flag.
hovertextsrc
Expand Down Expand Up @@ -1389,7 +1389,7 @@ def _prop_descriptions(self):
Sets text elements associated with each (a,b,c) point.
If a single string, the same string appears over all
the data points. If an array of strings, the items are
mapped in order to the the data points in (a,b,c). If
mapped in order of the data points in (a,b,c). If
trace `hoverinfo` contains a "text" flag and
"hovertext" is not set, these elements will be seen in
the hover labels.
Expand Down Expand Up @@ -1637,7 +1637,7 @@ def __init__(
Sets hover text elements associated with each (a,b,c)
point. If a single string, the same string appears over
all the data points. If an array of strings, the items
are mapped in order to the the data points in (a,b,c).
are mapped in order of the data points in (a,b,c).
To be seen, trace `hoverinfo` must contain a "text"
flag.
hovertextsrc
Expand Down Expand Up @@ -1743,7 +1743,7 @@ def __init__(
Sets text elements associated with each (a,b,c) point.
If a single string, the same string appears over all
the data points. If an array of strings, the items are
mapped in order to the the data points in (a,b,c). If
mapped in order of the data points in (a,b,c). If
trace `hoverinfo` contains a "text" flag and
"hovertext" is not set, these elements will be seen in
the hover labels.
Expand Down
6 changes: 3 additions & 3 deletions plotly/graph_objs/icicle/_pathbar.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ def edgeshape(self, val):
@property
def side(self):
"""
Determines on which side of the the treemap the `pathbar`
Determines on which side of the treemap the `pathbar`
should be presented.

The 'side' property is an enumeration that may be specified as:
Expand Down Expand Up @@ -117,7 +117,7 @@ def _prop_descriptions(self):
Determines which shape is used for edges between
`barpath` labels.
side
Determines on which side of the the treemap the
Determines on which side of the treemap the
`pathbar` should be presented.
textfont
Sets the font used inside `pathbar`.
Expand Down Expand Up @@ -153,7 +153,7 @@ def __init__(
Determines which shape is used for edges between
`barpath` labels.
side
Determines on which side of the the treemap the
Determines on which side of the treemap the
`pathbar` should be presented.
textfont
Sets the font used inside `pathbar`.
Expand Down
6 changes: 3 additions & 3 deletions plotly/graph_objs/treemap/_pathbar.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ def edgeshape(self, val):
@property
def side(self):
"""
Determines on which side of the the treemap the `pathbar`
Determines on which side of the treemap the `pathbar`
should be presented.

The 'side' property is an enumeration that may be specified as:
Expand Down Expand Up @@ -117,7 +117,7 @@ def _prop_descriptions(self):
Determines which shape is used for edges between
`barpath` labels.
side
Determines on which side of the the treemap the
Determines on which side of the treemap the
`pathbar` should be presented.
textfont
Sets the font used inside `pathbar`.
Expand Down Expand Up @@ -153,7 +153,7 @@ def __init__(
Determines which shape is used for edges between
`barpath` labels.
side
Determines on which side of the the treemap the
Determines on which side of the treemap the
`pathbar` should be presented.
textfont
Sets the font used inside `pathbar`.
Expand Down