Skip to content

Commit 8627242

Browse files
Merge branch 'doc-prod'
2 parents 03979d1 + c596d2e commit 8627242

File tree

81 files changed

+162
-160
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

81 files changed

+162
-160
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/2D-Histogram.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ fig = go.Figure(go.Histogram2d(x=x, y=y, histnorm='probability',
137137
fig.show()
138138
```
139139
### Sharing bin settings between 2D Histograms
140-
This example shows how to use [bingroup](https://plotly.com/python/reference/histogram/#histogram-bingroup) attribute to have a compatible bin settings for both histograms. To define `start`, `end` and `size` value of x-axis and y-axis seperatly, set [ybins](https://plotly.com/python/reference/histogram2dcontour/#histogram2dcontour-ybins) and `xbins`.
140+
This example shows how to use [bingroup](https://plotly.com/python/reference/histogram/#histogram-bingroup) attribute to have a compatible bin settings for both histograms. To define `start`, `end` and `size` value of x-axis and y-axis separately, set [ybins](https://plotly.com/python/reference/histogram2dcontour/#histogram2dcontour-ybins) and `xbins`.
141141

142142
```python
143143
import plotly.graph_objects as go

Diff for: doc/python/3d-isosurface-plots.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@ fig = go.Figure(data=go.Isosurface(
130130
fig.show()
131131
```
132132

133-
#### Isosurface with Addtional Slices
133+
#### Isosurface with Additional Slices
134134

135135
Here we visualize slices parallel to the axes on top of isosurfaces. For a clearer visualization, the `fill` ratio of isosurfaces is decreased below 1 (completely filled).
136136

@@ -235,4 +235,4 @@ fig.show()
235235
```
236236

237237
#### Reference
238-
See https://plotly.com/python/reference/isosurface/ for more information and chart attribute options!
238+
See https://plotly.com/python/reference/isosurface/ for more information and chart attribute options!

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/annotated-heatmap.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ fig.show()
8282
```
8383

8484
#### Custom Text and X & Y Labels
85-
set `annotation_text` to a matrix with the same dimmensions as `z`
85+
set `annotation_text` to a matrix with the same dimensions as `z`
8686

8787
```python
8888
import plotly.figure_factory as ff
@@ -203,4 +203,4 @@ fig.show()
203203

204204
#### Reference
205205

206-
For more info on Plotly heatmaps, see: https://plotly.com/python/reference/heatmap/.<br> For more info on using colorscales with Plotly see: https://plotly.com/python/heatmap-and-contour-colorscales/ <br>For more info on `ff.create_annotated_heatmap()`, see the [full function reference](https://plotly.com/python-api-reference/generated/plotly.figure_factory.create_annotated_heatmap.html#plotly.figure_factory.create_annotated_heatmap)
206+
For more info on Plotly heatmaps, see: https://plotly.com/python/reference/heatmap/.<br> For more info on using colorscales with Plotly see: https://plotly.com/python/heatmap-and-contour-colorscales/ <br>For more info on `ff.create_annotated_heatmap()`, see the [full function reference](https://plotly.com/python-api-reference/generated/plotly.figure_factory.create_annotated_heatmap.html#plotly.figure_factory.create_annotated_heatmap)

Diff for: doc/python/axes.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ The axis type is auto-detected by looking at data from the first [trace](/python
6666

6767
### Forcing an axis to be categorical
6868

69-
It is possible to force the axis type by setting explicitely `xaxis_type`. In the example below the automatic X axis type would be `linear` (because there are not more than twice as many unique strings as unique numbers) but we force it to be `category`.
69+
It is possible to force the axis type by setting explicitly `xaxis_type`. In the example below the automatic X axis type would be `linear` (because there are not more than twice as many unique strings as unique numbers) but we force it to be `category`.
7070

7171
```python
7272
import plotly.express as px
@@ -139,7 +139,7 @@ IFrame(snippet_url + 'axes', width='100%', height=630)
139139

140140
#### Moving Tick Labels Inside the Plot
141141

142-
The `ticklabelposition` attribute moves tick labels inside the plotting area, and modifies the auto-range behaviour to accomodate the labels.
142+
The `ticklabelposition` attribute moves tick labels inside the plotting area, and modifies the auto-range behaviour to accommodate the labels.
143143

144144
```python
145145
import plotly.express as px

Diff for: doc/python/builtin-colorscales.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ jupyter:
2323
version: 3.7.6
2424
plotly:
2525
description: A reference for the built-in named continuous (sequential, diverging
26-
and cylclical) color scales in Plotly.
26+
and cyclical) color scales in Plotly.
2727
display_as: file_settings
2828
has_thumbnail: true
2929
ipynb: ~notebook_demo/187

Diff for: doc/python/carpet-contour.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ jupyter:
3737

3838
### Basic Carpet Plot
3939

40-
Set the `x` and `y` coorindates, using `x` and `y` attributes. If `x` coorindate values are ommitted a cheater plot will be created. To save parameter values use `a` and `b` attributes. To make changes to the axes, use `aaxis` or `baxis` attributes. For a more detailed list of axes attributes refer to [python reference](https://plotly.com/python/reference/carpet/#carpet-aaxis).
40+
Set the `x` and `y` coordinates, using `x` and `y` attributes. If `x` coordinate values are omitted a cheater plot will be created. To save parameter values use `a` and `b` attributes. To make changes to the axes, use `aaxis` or `baxis` attributes. For a more detailed list of axes attributes refer to [python reference](https://plotly.com/python/reference/carpet/#carpet-aaxis).
4141

4242
```python
4343
import plotly.graph_objects as go
@@ -286,4 +286,4 @@ fig.show()
286286

287287
### Reference
288288

289-
See https://plotly.com/python/reference/contourcarpet/ for more information and chart attribute options!
289+
See https://plotly.com/python/reference/contourcarpet/ for more information and chart attribute options!

Diff for: doc/python/carpet-plot.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ jupyter:
3939
### Set X and Y Coordinates
4040

4141

42-
To set the `x` and `y` coordinates use `x` and `y` attributes. If `x` coordindate values are ommitted a cheater plot will be created. The plot below has a `y` array specified but requires `a` and `b` parameter values before an axis may be plotted.
42+
To set the `x` and `y` coordinates use `x` and `y` attributes. If `x` coordinate values are omitted a cheater plot will be created. The plot below has a `y` array specified but requires `a` and `b` parameter values before an axis may be plotted.
4343
<!-- #endregion -->
4444

4545
```python
@@ -189,4 +189,4 @@ To add points and lines see [Carpet Scatter Plots](https://plotly.com/python/car
189189

190190
### Reference
191191

192-
See https://plotly.com/python/reference/carpet/ for more information and chart attribute options!
192+
See https://plotly.com/python/reference/carpet/ for more information and chart attribute options!

Diff for: doc/python/categorical-axes.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ This page shows examples of how to configure [2-dimensional Cartesian axes](/pyt
4040

4141
The different types of Cartesian axes are configured via the `xaxis.type` or `yaxis.type` attribute, which can take on the following values:
4242

43-
- `'linear'` (see the [linear axes tutoria](/python/axes/))
43+
- `'linear'` (see the [linear axes tutorial](/python/axes/))
4444
- `'log'` (see the [log plot tutorial](/python/log-plots/))
4545
- `'date'` (see the [tutorial on timeseries](/python/time-series/))
4646
- `'category'` see below
@@ -55,7 +55,7 @@ The axis type is auto-detected by looking at data from the first [trace](/python
5555

5656
### Forcing an axis to be categorical
5757

58-
It is possible to force the axis type by setting explicitely `xaxis_type`. In the example below the automatic X axis type would be `linear` (because there are not more than twice as many unique strings as unique numbers) but we force it to be `category`.
58+
It is possible to force the axis type by setting explicitly `xaxis_type`. In the example below the automatic X axis type would be `linear` (because there are not more than twice as many unique strings as unique numbers) but we force it to be `category`.
5959

6060
```python
6161
import plotly.express as px

0 commit comments

Comments
 (0)