Skip to content

Commit c596d2e

Browse files
authoredFeb 18, 2021
Merge pull request #3079 from c-chaitanya/doc-prod
Doc prod
2 parents bb4a47c + 249fef0 commit c596d2e

37 files changed

+68
-68
lines changed
 

Diff for: ‎CHANGELOG.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).
135135
faster image rendering and smaller figure size. Additional optional arguments
136136
`binary_backend`, `binary_format` and `binary_compression_level` control
137137
how to generate the b64 string ([#2691](https://github.com/plotly/plotly.py/pull/2691)
138-
- `px.imshow` has a new `constrast_rescaling` argument in order to choose how
138+
- `px.imshow` has a new `contrast_rescaling` argument in order to choose how
139139
to set data values corresponding to the bounds of the color range
140140
([#2691](https://github.com/plotly/plotly.py/pull/2691)
141141

@@ -239,7 +239,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).
239239

240240
### Added
241241

242-
- The `hover_data` parameter of `px` functions can now be a dictionary. This makes it possible to skip hover information for some arguments or to change the formatting of hover informatiom [#2377](https://github.com/plotly/plotly.py/pull/2377).
242+
- The `hover_data` parameter of `px` functions can now be a dictionary. This makes it possible to skip hover information for some arguments or to change the formatting of hover information [#2377](https://github.com/plotly/plotly.py/pull/2377).
243243
- It's now possible to build a development version of Plotly.py against the build artifacts from a non-`master` branch of Plotly.js, which makes for faster QA and development cycles [#2349](https://github.com/plotly/plotly.py/pull/2349). Thanks [@zouhairm](https://github.com/zouhairm) for this Pull Request!
244244

245245
### Fixed
@@ -252,7 +252,7 @@ This version includes several performance improvements ([#2368](https://github.c
252252

253253
- Child graph objects (e.g. `figure.layout.xaxis`) are no longer created eagerly during graph object construction. Instead, they are created lazily the first time the property is accessed.
254254
- Property validation is now disabled for select internal operations.
255-
- When used with Python 3.7 and above, ploty.py now takes advantage of [PEP-562](https://www.python.org/dev/peps/pep-0562/) to perform submodule imports lazily. This dramatically improves import times.
255+
- When used with Python 3.7 and above, plotly.py now takes advantage of [PEP-562](https://www.python.org/dev/peps/pep-0562/) to perform submodule imports lazily. This dramatically improves import times.
256256

257257
## [4.6.0] - 2020-03-31
258258

@@ -290,7 +290,7 @@ This version includes several performance improvements ([#2368](https://github.c
290290

291291
- Jupyterlab extension now compatible with both Jupyterlab 1.2 and 2.0 [#2261](https://github.com/plotly/plotly.py/pull/2261) with thanks to [@consideRatio](https://github.com/consideRatio) for the contribution!
292292
- Fixed a bug when using boolean values for the color argument of px functions [#2127](https://github.com/plotly/plotly.py/pull/2127)
293-
- Corrected import bug which was occuring with old versions of ipywidgets [#2265](https://github.com/plotly/plotly.py/pull/2265)
293+
- Corrected import bug which was occurring with old versions of ipywidgets [#2265](https://github.com/plotly/plotly.py/pull/2265)
294294
- Fixed python 3.8 syntax warning [#2262](https://github.com/plotly/plotly.py/pull/2262), with thanks to [@sgn](https://github.com/sgn) for the contribution!
295295

296296
## [4.5.3] - 2020-03-05
@@ -365,7 +365,7 @@ This version includes several performance improvements ([#2368](https://github.c
365365
for more information
366366
- The tutorials of the [plotly.py documentation](https://plot.ly/python/) are
367367
now in the main [plotly.py Github repository](https://github.com/plotly/plotly.py). Contributions in order to improve or extend the documentation are very welcome!
368-
- `plotly.express` generated plots no longer have a default height of 600 pixels, instead they inherit the default height of regular figures [#1990](https://github.com/plotly/plotly.py/pull/1990). To restore the old behavior, set `px.defaults.height=600` once per session, or set the `height` keyword arguement to any `px.function()` to 600.
368+
- `plotly.express` generated plots no longer have a default height of 600 pixels, instead they inherit the default height of regular figures [#1990](https://github.com/plotly/plotly.py/pull/1990). To restore the old behavior, set `px.defaults.height=600` once per session, or set the `height` keyword argument to any `px.function()` to 600.
369369

370370
### Fixed
371371

@@ -439,7 +439,7 @@ section [#1969](https://github.com/plotly/plotly.py/pull/1969).
439439
- The width of a figure produced by the `create_gantt` figure factory now resizes responsively ([#1724](https://github.com/plotly/plotly.py/pull/1724))
440440

441441
### Fixed
442-
- The name of the steps property of `graph_objects.indicator.Guage` has been renamed from `stepss` to `steps`
442+
- The name of the steps property of `graph_objects.indicator.Gauge` has been renamed from `stepss` to `steps`
443443
- Avoid crash in iframe renderers when running outside iPython ([#1723](https://github.com/plotly/plotly.py/pull/1723))
444444

445445
## [4.1.0] - 2019-08-06
@@ -491,7 +491,7 @@ This is a major release that includes many new features, and a few breaking chan
491491
- Added support for all trace types in `make_subplots` ([#1528](https://github.com/plotly/plotly.py/pull/1528))
492492
- Added support for secondary y-axes in `make_subplots` ([#1564](https://github.com/plotly/plotly.py/pull/1564))
493493
- Support passing a scalar trace object (rather than a list or tuple of trace objects) as the `data` property to the `Figure` constructor ([#1614](https://github.com/plotly/plotly.py/pull/1614))
494-
- Added dictionary-stule `.pop` method to graph object classes ([#1614](https://github.com/plotly/plotly.py/pull/1614))
494+
- Added dictionary-style `.pop` method to graph object classes ([#1614](https://github.com/plotly/plotly.py/pull/1614))
495495
- New `jupyterlab-plotly` JupyterLab extension for rendering figures in JupyterLab. Replaces the `@jupyterlab/plotly-extension` extension, and includes JupyterLab 1.0 support.
496496
- Added new suite of built-in colorscales to the `plotly.colors` module, and support for specifying this wide range of colorscales by name. Also added support for specifying colorscales as a list of colors, in which case the color spacing is assumed to be uniform ([#1647](https://github.com/plotly/plotly.py/pull/1647)).
497497
- Added `sphinx-gallery` renderer for embedding plotly figures in [Sphinx-Gallery](https://sphinx-gallery.github.io/) ([#1577](https://github.com/plotly/plotly.py/pull/1577), [plotly/plotly-sphinx-gallery](https://github.com/plotly/plotly-sphinx-gallery)).
@@ -1096,7 +1096,7 @@ must be installed:
10961096
properties are ignored rather than causing an exception.
10971097
- A `to_ordered_dict` method has been added to the `Figure` and `FigureWidget`
10981098
classes. This method returns a representation of the figure as a nested
1099-
structure of `OrdererdDict` and `list` instances where the keys in each
1099+
structure of `OrderedDict` and `list` instances where the keys in each
11001100
`OrderedDict` are sorted alphabetically. This method replaces the
11011101
`get_ordered` method that was available in version 2, and makes it possible
11021102
to traverse the nested structure of a figure in a deterministic order.
@@ -1517,7 +1517,7 @@ gone.
15171517
## [1.12.10] - 2016-11-28
15181518
### Updated
15191519
- `FF.create_violin` and `FF.create_scatterplotmatrix` now by default do not print subplot grid information in output
1520-
- Removed alert that occured when downloading plot images offline. Please note: for higher resolution images and more export options, consider making requests to our image servers. See: `help(py.image)` for more details.
1520+
- Removed alert that occurred when downloading plot images offline. Please note: for higher resolution images and more export options, consider making requests to our image servers. See: `help(py.image)` for more details.
15211521

15221522
### Added
15231523
- Plot configuration options for offline plots. See the list of [configuration options](https://github.com/Rikorose/plotly.py/blob/master/plotly/offline/offline.py#L189) and [examples](https://plot.ly/javascript/configuration-options/) for more information.

Diff for: ‎build_for_conda.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,4 +16,4 @@ Finally, build and test the created version:
1616

1717
`conda build plotly`
1818

19-
Currently, the updated (version 1.12.4) conda package sits at https://anaconda.org/chohner/plotly. There seems to be an old offial package at https://anaconda.org/plotly/plotly.
19+
Currently, the updated (version 1.12.4) conda package sits at https://anaconda.org/chohner/plotly. There seems to be an old official package at https://anaconda.org/plotly/plotly.

Diff for: ‎doc/python/3d-mesh.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ IFrame(snippet_url + '3d-mesh', width='100%', height=630)
8383

8484
### Mesh Tetrahedron
8585

86-
In this example we use the `ì`, `j` and `k` parameters to specify manually the geometry of the triangles of the mesh.
86+
In this example we use the `i`, `j` and `k` parameters to specify manually the geometry of the triangles of the mesh.
8787

8888
```python
8989
import plotly.graph_objects as go

Diff for: ‎doc/python/linear-fits.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ jupyter:
2323
version: 3.6.8
2424
plotly:
2525
description: Add linear Ordinary Least Squares (OLS) regression trendlines or
26-
non-linear Locally Weighted Scatterplot Smoothing (LOEWSS) trendlines to scatterplots
26+
non-linear Locally Weighted Scatterplot Smoothing (LOWESS) trendlines to scatterplots
2727
in Python.
2828
display_as: statistical
2929
language: python
@@ -76,4 +76,4 @@ import plotly.express as px
7676
df = px.data.gapminder().query("year == 2007")
7777
fig = px.scatter(df, x="gdpPercap", y="lifeExp", color="continent", trendline="lowess")
7878
fig.show()
79-
```
79+
```

Diff for: ‎doc/python/ml-regression.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,7 @@ fig.show()
174174
Notice how linear regression fits a straight line, but kNN can take non-linear shapes. Moreover, it is possible to extend linear regression to polynomial regression by using scikit-learn's `PolynomialFeatures`, which lets you fit a slope for your features raised to the power of `n`, where `n=1,2,3,4` in our example.
175175

176176

177-
With Plotly, it's easy to diplay latex equations in legend and titles by simply adding `$` before and after your equation. This way, you can see the coefficients that our polynomial regression fitted.
177+
With Plotly, it's easy to display latex equations in legend and titles by simply adding `$` before and after your equation. This way, you can see the coefficients that our polynomial regression fitted.
178178
<!-- #endregion -->
179179

180180
```python

Diff for: ‎doc/python/sliders.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ The method determines which [plotly.js function](https://plot.ly/javascript/plot
9090

9191

9292
### Sliders in Plotly Express
93-
Plotly Express provide sliders, but with implicit animation using the `"animate"` method described above. The animation play button can be omited by removing `updatemenus` in the `layout`:
93+
Plotly Express provide sliders, but with implicit animation using the `"animate"` method described above. The animation play button can be omitted by removing `updatemenus` in the `layout`:
9494

9595
```python
9696
import plotly.express as px

Diff for: ‎doc/python/ternary-plots.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ A ternary plot depicts the ratios of three variables as positions in an equilate
4141

4242
[Plotly Express](/python/plotly-express/) is the easy-to-use, high-level interface to Plotly, which [operates on a variety of types of data](/python/px-arguments/) and produces [easy-to-style figures](/python/styling-plotly-express/).
4343

44-
Here we use `px.scatter_ternary` to visualize thre three-way split between the three major candidates in a municipal election.
44+
Here we use `px.scatter_ternary` to visualize the three-way split between the three major candidates in a municipal election.
4545

4646
```python
4747
import plotly.express as px

Diff for: ‎doc/unconverted/python/3d-parametric-plots.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ jupyter:
1212
language: python
1313
name: python2
1414
plotly:
15-
description: How to 3D Parameteric Plots in Python
15+
description: How to 3D Parametric Plots in Python
1616
display_as: 3d_charts
1717
language: python
1818
layout: base
@@ -80,7 +80,7 @@ py.iplot(fig, filename='Parametric_plot')
8080
```
8181

8282
<!-- #region {"deletable": true, "editable": true} -->
83-
#### Parameteric Plot with Colorscale
83+
#### Parametric Plot with Colorscale
8484
<!-- #endregion -->
8585

8686
```python deletable=true editable=true

Diff for: ‎doc/unconverted/python/amazon-redshift.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ port = 5439
6868
dbname = 'dev'
6969
```
7070

71-
As I mentioned there are numerous ways to connect to a Redshift databause and I've included two below. We can use either the SQLAlchemy package or we can use the psycopg2 package for a more direct access.
71+
As I mentioned there are numerous ways to connect to a Redshift database and I've included two below. We can use either the SQLAlchemy package or we can use the psycopg2 package for a more direct access.
7272

7373
Both will allow us to execute SQL queries and get results however the SQLAlchemy engine makes it a bit easier to directly return our data as a dataframe using pandas. Plotly has a tight integration with pandas as well, making it extremely easy to make interactive graphs to share with your company.
7474

Diff for: ‎doc/unconverted/python/anova.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ jupyter:
2525
---
2626

2727
#### New to Plotly?
28-
Plotly's Python library is free and open source! [Get started](https://plot.ly/python/getting-started/) by dowloading the client and [reading the primer](https://plot.ly/python/getting-started/).
28+
Plotly's Python library is free and open source! [Get started](https://plot.ly/python/getting-started/) by downloading the client and [reading the primer](https://plot.ly/python/getting-started/).
2929
<br>You can set up Plotly to work in [online](https://plot.ly/python/getting-started/#initialization-for-online-plotting) or [offline](https://plot.ly/python/getting-started/#initialization-for-offline-plotting) mode, or in [jupyter notebooks](https://plot.ly/python/getting-started/#start-plotting-online).
3030
<br>We also have a quick-reference [cheatsheet](https://images.plot.ly/plotly-documentation/images/python_cheat_sheet.pdf) (new!) to help you get started!
3131

Diff for: ‎doc/unconverted/python/average_multiple_curves.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ jupyter:
2525
---
2626

2727
#### New to Plotly?
28-
Plotly's Python library is free and open source! [Get started](https://plot.ly/python/getting-started/) by dowloading the client and [reading the primer](https://plot.ly/python/getting-started/).
28+
Plotly's Python library is free and open source! [Get started](https://plot.ly/python/getting-started/) by downloading the client and [reading the primer](https://plot.ly/python/getting-started/).
2929
<br>You can set up Plotly to work in [online](https://plot.ly/python/getting-started/#initialization-for-online-plotting) or [offline](https://plot.ly/python/getting-started/#initialization-for-offline-plotting) mode, or in [jupyter notebooks](https://plot.ly/python/getting-started/#start-plotting-online).
3030
<br>We also have a quick-reference [cheatsheet](https://images.plot.ly/plotly-documentation/images/python_cheat_sheet.pdf) (new!) to help you get started!
3131

Diff for: ‎doc/unconverted/python/baseline-subtraction.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ py.iplot(table, filename='milk-production-dataframe')
6060
```
6161

6262
#### Plot with Baseline
63-
To subtact a baseline estimate from our data, it is a good idea to first we must first calculate the baseline values then plot the data with the baseline drawn in.
63+
To subtract a baseline estimate from our data, it is a good idea to first we must first calculate the baseline values then plot the data with the baseline drawn in.
6464

6565
```python
6666
baseline_values = peakutils.baseline(time_series)

Diff for: ‎doc/unconverted/python/basic-statistics.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ jupyter:
2525
---
2626

2727
#### New to Plotly?
28-
Plotly's Python library is free and open source! [Get started](https://plot.ly/python/getting-started/) by dowloading the client and [reading the primer](https://plot.ly/python/getting-started/).
28+
Plotly's Python library is free and open source! [Get started](https://plot.ly/python/getting-started/) by downloading the client and [reading the primer](https://plot.ly/python/getting-started/).
2929
<br>You can set up Plotly to work in [online](https://plot.ly/python/getting-started/#initialization-for-online-plotting) or [offline](https://plot.ly/python/getting-started/#initialization-for-offline-plotting) mode, or in [jupyter notebooks](https://plot.ly/python/getting-started/#start-plotting-online).
3030
<br>We also have a quick-reference [cheatsheet](https://images.plot.ly/plotly-documentation/images/python_cheat_sheet.pdf) (new!) to help you get started!
3131

Diff for: ‎doc/unconverted/python/chord-diagram.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -45,10 +45,10 @@ To avoid cluttered edges we adopted the following procedure in choosing the inte
4545
- define a list, `Dist`, having as elements the distances between the following pairs of points:
4646
$$(P_1, P_1), \:(P_1, P_2), \: (P_1, P_3),\: (P_1, P_4),\: (P_1, P_5)$$
4747

48-
- In order to assign the control poligon to the B&eacute;zier curve that will be the edge between two connected
48+
- In order to assign the control polygon to the B&eacute;zier curve that will be the edge between two connected
4949
nodes, `V[i], V[j]`, we compute the distance between these nodes, and deduce the interval $k$, of two consecutive values in `Dist`, this distance belongs to.
5050

51-
- Since there are four such intervals indexed $k=0,1,2,3$, we define the control poligon as follows: $${\bf b}_0=V[i],\:\: {\bf b}_1=V[i]/param,\:\: {\bf b}_2=V[j]/param, \:\:{\bf b}_3=V[j],$$ where `param` is chosen from the list: `params=[1.2, 1.5, 1.8, 2.1]`.
51+
- Since there are four such intervals indexed $k=0,1,2,3$, we define the control polygon as follows: $${\bf b}_0=V[i],\:\: {\bf b}_1=V[i]/param,\:\: {\bf b}_2=V[j]/param, \:\:{\bf b}_3=V[j],$$ where `param` is chosen from the list: `params=[1.2, 1.5, 1.8, 2.1]`.
5252

5353
Namely, if the distance(`V[i], V[j]`), belongs to the $K^{th}$ interval associated to `Dist`, then we choose `param= params[K]`.
5454

Diff for: ‎doc/unconverted/python/density-plots.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ jupyter:
2626

2727
<!-- #region {"deletable": true, "editable": true} -->
2828
#### New to Plotly?
29-
Plotly's Python library is free and open source! [Get started](https://plot.ly/python/getting-started/) by dowloading the client and [reading the primer](https://plot.ly/python/getting-started/).
29+
Plotly's Python library is free and open source! [Get started](https://plot.ly/python/getting-started/) by downloading the client and [reading the primer](https://plot.ly/python/getting-started/).
3030
<br>You can set up Plotly to work in [online](https://plot.ly/python/getting-started/#initialization-for-online-plotting) or [offline](https://plot.ly/python/getting-started/#initialization-for-offline-plotting) mode, or in [jupyter notebooks](https://plot.ly/python/getting-started/#start-plotting-online).
3131
<br>We also have a quick-reference [cheatsheet](https://images.plot.ly/plotly-documentation/images/python_cheat_sheet.pdf) (new!) to help you get started!
3232
<!-- #endregion -->

Diff for: ‎doc/unconverted/python/discrete-frequency.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ jupyter:
2525
---
2626

2727
#### New to Plotly?
28-
Plotly's Python library is free and open source! [Get started](https://plot.ly/python/getting-started/) by dowloading the client and [reading the primer](https://plot.ly/python/getting-started/).
28+
Plotly's Python library is free and open source! [Get started](https://plot.ly/python/getting-started/) by downloading the client and [reading the primer](https://plot.ly/python/getting-started/).
2929
<br>You can set up Plotly to work in [online](https://plot.ly/python/getting-started/#initialization-for-online-plotting) or [offline](https://plot.ly/python/getting-started/#initialization-for-offline-plotting) mode, or in [jupyter notebooks](https://plot.ly/python/getting-started/#start-plotting-online).
3030
<br>We also have a quick-reference [cheatsheet](https://images.plot.ly/plotly-documentation/images/python_cheat_sheet.pdf) (new!) to help you get started!
3131

@@ -115,7 +115,7 @@ py.iplot(fig, filename='histogram-percentage')
115115
#### Cumulative Density Function
116116

117117

118-
We can also take the cumulatve sum of our dataset and then plot the cumulative density function, or `CDF`, as a scatter plot
118+
We can also take the cumulative sum of our dataset and then plot the cumulative density function, or `CDF`, as a scatter plot
119119

120120
```python
121121
cumsum = np.cumsum(x)

0 commit comments

Comments
 (0)
Please sign in to comment.