Skip to content

Commit e6e2a94

Browse files
committed
Fix typos and grammar errors in documentation and source code
Fix 39 errors across 30 files in hand-written source code and documentation: Spelling fixes: - "seperate" -> "separate" (utils.py, _facet_grid.py) - "auxilary" -> "auxiliary" (callbacks.py, 2 instances) - "immediatly" -> "immediately" (basewidget.py) - "paramter" -> "parameter" (png.py) - "coresponding" -> "corresponding" (2d-projection-of-3d-surface.md) - "indicies" -> "indices", "verticies" -> "vertices" (_trisurf.py, renderer.py) - "coverted" -> "converted", "specificed" -> "specified", "legnth" -> "length", "aswell" -> "as well" (colors/__init__.py) - "vica versa" -> "vice versa" (v4-migration.md) - "explictly" -> "explicitly" (pattern-hatching-texture.md) - "Ploty" -> "Plotly" (__init__.py, io/__init__.py) Double word fixes: - "the the" -> "the" (5 instances in .md files, 1 in CONTRIBUTING.md) - "to to" -> "to" (offline.py, basedatatypes.py) - "is is" -> "is" (marker-style.md) - "and and" -> "and" (v4-migration.md) - "on on" -> "on" (ecdf-plots.md) - "a a" -> "a" (outlier-test.md) - "that that" -> "that" (normality-test.md) - "in in" -> "in" (CHANGELOG.md) - "be be" -> "be" (test_lazy_imports.py) - "a an" -> "an" (axes.md) Grammar fixes: - "a integer" -> "an integer" (basevalidators.py - fixes 500+ generated files) - "a HTML report or an website" -> "an HTML report or a website" (offline.py) - "a object" -> "an object" (basedatatypes.py) - "it's" -> "its" as possessive (basedatatypes.py) - "diagnoses" -> "diagnose" wrong verb form (ml-regression.md) Broken link fixes: - Fix empty links for [Box plots]() and [violin plots]() (categorical-axes.md)
1 parent b009b25 commit e6e2a94

30 files changed

+39
-39
lines changed

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -798,7 +798,7 @@ Items in this section may be considered backwards-incompatible changes for the p
798798
- if either `x` or `y` (but not both) may now be provided as a list of column references into `data_frame` or columns of data, in which case the imputed data frame will be treated as "wide" data and `melt()`ed internally before applying the usual mapping rules, with function-specific defaults.
799799
- if neither `x` nor `y` is provided but `data_frame` is, the data frame will be treated as "wide" with defaults depending on the value of `orientation` (and `orientation` has accordingly been added to `scatter`, `line`, `density_heatmap`, and `density_contour` for this purpose). Previously this would have resulted in an empty figure.
800800
- if both `x` and `y` are provided to `histogram`, and if `x`, `y` and `z` are provided to `density_heatmap` or `density_contour`, then `histfunc` now defaults to `sum` so as to avoid ignoring the provided data, and to cause `histogram` and `bar` to behave more similarly.
801-
- `violinmode`, `boxmode` and `stripmode` now default to `overlay` if `x` (`y`) in in `v` (`h`) orientation is also mapped to `color`, to avoid strange spacing issues with the previous default of `group` in all cases.
801+
- `violinmode`, `boxmode` and `stripmode` now default to `overlay` if `x` (`y`) in `v` (`h`) orientation is also mapped to `color`, to avoid strange spacing issues with the previous default of `group` in all cases.
802802
- The Plotly Express arguments `color_discrete_map`, `symbol_map` and `line_dash_map` now accept the string `"identity"` which causes the corresponding input data to be used as-is rather than mapped into `color_discrete_sequence`, `symbol_sequence` or `line_dash_sequence`, respectively. ([#2336](https://github.com/plotly/plotly.py/pull/2336))
803803
- Plotly Express now accepts `px.Constant` or `px.Range` objects in the place of column references so as to express constant or increasing integer values. ([#2336](https://github.com/plotly/plotly.py/pull/2336))
804804

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -178,7 +178,7 @@ When creating your pull request, please follow the guidelines below.
178178
### Code pull request
179179

180180
- *Make sure you have reviewed the full [contributing notes (this file)](https://github.com/plotly/plotly.py/blob/main/CONTRIBUTING.md) and understand the structure of the package.*
181-
- If your PR modifies code of `plotly.graph_objects`, the modifications should be made to the the code generator, *not* the generated files.
181+
- If your PR modifies code of `plotly.graph_objects`, the modifications should be made to the code generator, *not* the generated files.
182182
- You have added tests or modified existing tests, as needed.
183183
- For a new feature, you have added documentation examples (please see the doc checklist as well).
184184
- You have added a CHANGELOG entry if changing anything substantial.

_plotly_utils/basevalidators.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -878,7 +878,7 @@ def __init__(
878878

879879
def description(self):
880880
desc = """\
881-
The '{plotly_name}' property is a integer and may be specified as:""".format(
881+
The '{plotly_name}' property is an integer and may be specified as:""".format(
882882
plotly_name=self.plotly_name
883883
)
884884

_plotly_utils/colors/__init__.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -419,10 +419,10 @@ def convert_colors_to_same_type(
419419
420420
Takes a single color or an iterable of colors, as well as a list of scale
421421
values, and outputs a 2-pair of the list of color(s) converted all to an
422-
rgb or tuple color type, aswell as the scale as the second element. If
422+
rgb or tuple color type, as well as the scale as the second element. If
423423
colors is a Plotly Scale name, then 'scale' will be forced to the scale
424424
from the respective colorscale and the colors in that colorscale will also
425-
be coverted to the selected colortype. If colors is None, then there is an
425+
be converted to the selected colortype. If colors is None, then there is an
426426
option to return portion of the DEFAULT_PLOTLY_COLORS
427427
428428
:param (str|tuple|list) colors: either a plotly scale name, an rgb or hex
@@ -567,8 +567,8 @@ def make_colorscale(colors, scale=None):
567567
568568
Takes a list of colors and scales and constructs a colorscale based
569569
on the colors in sequential order. If 'scale' is left empty, a linear-
570-
interpolated colorscale will be generated. If 'scale' is a specificed
571-
list, it must be the same legnth as colors and must contain all floats
570+
interpolated colorscale will be generated. If 'scale' is a specified
571+
list, it must be the same length as colors and must contain all floats
572572
For documentation regarding to the form of the output, see
573573
https://plot.ly/python/reference/#mesh3d-colorscale
574574

_plotly_utils/png.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -350,7 +350,7 @@ class ChunkError(FormatError):
350350

351351

352352
class Default:
353-
"""The default for the greyscale paramter."""
353+
"""The default for the greyscale parameter."""
354354

355355

356356
class Writer:

doc/python/axes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -693,7 +693,7 @@ fig.show()
693693

694694
*New in 5.17*
695695

696-
You can also set just a lower or upper bound manually and have autorange applied to the other bound by setting it to `None`. In the following example, we set a an upper bound of 4.5 on the x axes, while specifying `None` for the lower bound, meaning it will use autorange. On the y axes, we set the lower bound, and use `None` for the upper bound, meaning that uses autorange.
696+
You can also set just a lower or upper bound manually and have autorange applied to the other bound by setting it to `None`. In the following example, we set an upper bound of 4.5 on the x axes, while specifying `None` for the lower bound, meaning it will use autorange. On the y axes, we set the lower bound, and use `None` for the upper bound, meaning that uses autorange.
697697

698698
```python
699699
import plotly.express as px

doc/python/carpet-plot.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ fig.show()
117117
### Cheater plot layout
118118

119119

120-
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.
120+
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.
121121

122122
```python
123123
import plotly.graph_objects as go

doc/python/categorical-axes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ fig.update_traces(marker_size=10)
7979
fig.show()
8080
```
8181

82-
[Box plots]() and [violin plots]() are often shown with one categorical and one continuous axis.
82+
[Box plots](/python/box-plots/) and [violin plots](/python/violin/) are often shown with one categorical and one continuous axis.
8383

8484
```python
8585
import plotly.express as px

doc/python/ecdf-plots.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ fig.show()
9090

9191
### Reversed and Complementary CDF plots
9292

93-
By default, the Y value represents the fraction of the data that is *at or below* the value on on the X axis. Setting `ecdfmode` to `"reversed"` reverses this, with the Y axis representing the fraction of the data *at or above* the X value. Setting `ecdfmode` to `"complementary"` plots `1-ECDF`, meaning that the Y values represent the fraction of the data *above* the X value.
93+
By default, the Y value represents the fraction of the data that is *at or below* the value on the X axis. Setting `ecdfmode` to `"reversed"` reverses this, with the Y axis representing the fraction of the data *at or above* the X value. Setting `ecdfmode` to `"complementary"` plots `1-ECDF`, meaning that the Y values represent the fraction of the data *above* the X value.
9494

9595
In `standard` mode (the default), the right-most point is at 1 (or the total count/sum, depending on `ecdfnorm`) and the right-most point is above 0.
9696

doc/python/marker-style.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -309,7 +309,7 @@ fig.show()
309309

310310
To maximise visibility of each point, set the color as an `rgba` string that includes an alpha value of 0.5.
311311

312-
This example sets the marker color to `'rgba(135, 206, 250, 0.5)'`. The rgb values of 135, 206, and 250 are from the definition of the `LightSkyBlue` named CSS color that is is used in the previous examples (See https://www.color-hex.com/color/87cefa). The marker line will remain opaque.
312+
This example sets the marker color to `'rgba(135, 206, 250, 0.5)'`. The rgb values of 135, 206, and 250 are from the definition of the `LightSkyBlue` named CSS color that is used in the previous examples (See https://www.color-hex.com/color/87cefa). The marker line will remain opaque.
313313

314314
```python
315315
import plotly.graph_objects as go

0 commit comments

Comments
 (0)