Skip to content

Commit f512eb8

Browse files
committed
Revert "update docstrings" commit which removed deprecation language
This reverts commit 467c135.
1 parent 0f9141b commit f512eb8

File tree

2 files changed

+44
-48
lines changed

2 files changed

+44
-48
lines changed

plotly/basedatatypes.py

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -3724,29 +3724,29 @@ def to_image(self, *args, **kwargs):
37243724
- 'webp'
37253725
- 'svg'
37263726
- 'pdf'
3727-
- 'eps' (Kaleido v0.* only) (Requires the poppler library to be installed)
3727+
- 'eps' (deprecated) (Requires the poppler library to be installed)
37283728
37293729
If not specified, will default to:
3730-
- `plotly.io.defaults.default_format` or `plotly.io.kaleido.scope.default_format` if engine is "kaleido"
3731-
- `plotly.io.orca.config.default_format` if engine is "orca"
3730+
- `plotly.io.defaults.default_format` if engine is "kaleido"
3731+
- `plotly.io.orca.config.default_format` if engine is "orca" (deprecated)
37323732
37333733
width: int or None
37343734
The width of the exported image in layout pixels. If the `scale`
37353735
property is 1.0, this will also be the width of the exported image
37363736
in physical pixels.
37373737
37383738
If not specified, will default to:
3739-
- `plotly.io.defaults.default_width` or `plotly.io.kaleido.scope.default_width` if engine is "kaleido"
3740-
- `plotly.io.orca.config.default_width` if engine is "orca"
3739+
- `plotly.io.defaults.default_width` if engine is "kaleido"
3740+
- `plotly.io.orca.config.default_width` if engine is "orca" (deprecated)
37413741
37423742
height: int or None
37433743
The height of the exported image in layout pixels. If the `scale`
37443744
property is 1.0, this will also be the height of the exported image
37453745
in physical pixels.
37463746
37473747
If not specified, will default to:
3748-
- `plotly.io.defaults.default_height` or `plotly.io.kaleido.scope.default_height` if engine is "kaleido"
3749-
- `plotly.io.orca.config.default_height` if engine is "orca"
3748+
- `plotly.io.defaults.default_height` if engine is "kaleido"
3749+
- `plotly.io.orca.config.default_height` if engine is "orca" (deprecated)
37503750
37513751
scale: int or float or None
37523752
The scale factor to use when exporting the figure. A scale factor
@@ -3755,14 +3755,14 @@ def to_image(self, *args, **kwargs):
37553755
less than 1.0 will decrease the image resolution.
37563756
37573757
If not specified, will default to:
3758-
- `plotly.io.defaults.default_scale` or `plotly.io.kaleido.scope.default_scale` if engine is "kaliedo"
3759-
- `plotly.io.orca.config.default_scale` if engine is "orca"
3758+
- `plotly.io.defaults.default_scale` if engine is "kaliedo"
3759+
- `plotly.io.orca.config.default_scale` if engine is "orca" (deprecated)
37603760
37613761
validate: bool
37623762
True if the figure should be validated before being converted to
37633763
an image, False otherwise.
37643764
3765-
engine: str
3765+
engine (deprecated): str
37663766
Image export engine to use. This parameter is deprecated and Orca engine support will be
37673767
dropped in the next major Plotly version. Until then, the following values are supported:
37683768
- "kaleido": Use Kaleido for image export
@@ -3818,31 +3818,31 @@ def write_image(self, *args, **kwargs):
38183818
- 'webp'
38193819
- 'svg'
38203820
- 'pdf'
3821-
- 'eps' (Kaleido v0.* only) (Requires the poppler library to be installed)
3821+
- 'eps' (deprecated) (Requires the poppler library to be installed)
38223822
38233823
If not specified and `file` is a string then this will default to the
38243824
file extension. If not specified and `file` is not a string then this
38253825
will default to:
3826-
- `plotly.io.defaults.default_format` or `plotly.io.kaleido.scope.default_format` if engine is "kaleido"
3827-
- `plotly.io.orca.config.default_format` if engine is "orca"
3826+
- `plotly.io.defaults.default_format` if engine is "kaleido"
3827+
- `plotly.io.orca.config.default_format` if engine is "orca" (deprecated)
38283828
38293829
width: int or None
38303830
The width of the exported image in layout pixels. If the `scale`
38313831
property is 1.0, this will also be the width of the exported image
38323832
in physical pixels.
38333833
38343834
If not specified, will default to:
3835-
- `plotly.io.defaults.default_width` or `plotly.io.kaleido.scope.default_width` if engine is "kaleido"
3836-
- `plotly.io.orca.config.default_width` if engine is "orca"
3835+
- `plotly.io.defaults.default_width` if engine is "kaleido"
3836+
- `plotly.io.orca.config.default_width` if engine is "orca" (deprecated)
38373837
38383838
height: int or None
38393839
The height of the exported image in layout pixels. If the `scale`
38403840
property is 1.0, this will also be the height of the exported image
38413841
in physical pixels.
38423842
38433843
If not specified, will default to:
3844-
- `plotly.io.defaults.default_height` or `plotly.io.kaleido.scope.default_height` if engine is "kaleido"
3845-
- `plotly.io.orca.config.default_height` if engine is "orca"
3844+
- `plotly.io.defaults.default_height` if engine is "kaleido"
3845+
- `plotly.io.orca.config.default_height` if engine is "orca" (deprecated)
38463846
38473847
scale: int or float or None
38483848
The scale factor to use when exporting the figure. A scale factor
@@ -3851,14 +3851,14 @@ def write_image(self, *args, **kwargs):
38513851
less than 1.0 will decrease the image resolution.
38523852
38533853
If not specified, will default to:
3854-
- `plotly.io.defaults.default_scale` or `plotly.io.kaleido.scope.default_scale` if engine is "kaleido"
3855-
- `plotly.io.orca.config.default_scale` if engine is "orca"
3854+
- `plotly.io.defaults.default_scale` if engine is "kaleido"
3855+
- `plotly.io.orca.config.default_scale` if engine is "orca" (deprecated)
38563856
38573857
validate: bool
38583858
True if the figure should be validated before being converted to
38593859
an image, False otherwise.
38603860
3861-
engine: str
3861+
engine (deprecated): str
38623862
Image export engine to use. This parameter is deprecated and Orca engine support will be
38633863
dropped in the next major Plotly version. Until then, the following values are supported:
38643864
- "kaleido": Use Kaleido for image export

plotly/io/_kaleido.py

Lines changed: 24 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -247,29 +247,29 @@ def to_image(
247247
- 'webp'
248248
- 'svg'
249249
- 'pdf'
250-
- 'eps' (Kaleido v0.* only) (Requires the poppler library to be installed and on the PATH)
250+
- 'eps' (deprecated) (Requires the poppler library to be installed and on the PATH)
251251
252252
If not specified, will default to:
253-
- `plotly.io.defaults.default_format` or `plotly.io.kaleido.scope.default_format` if engine is "kaleido"
254-
- `plotly.io.orca.config.default_format` if engine is "orca"
253+
- `plotly.io.defaults.default_format` if engine is "kaleido"
254+
- `plotly.io.orca.config.default_format` if engine is "orca" (deprecated)
255255
256256
width: int or None
257257
The width of the exported image in layout pixels. If the `scale`
258258
property is 1.0, this will also be the width of the exported image
259259
in physical pixels.
260260
261261
If not specified, will default to:
262-
- `plotly.io.defaults.default_width` or `plotly.io.kaleido.scope.default_width` if engine is "kaleido"
263-
- `plotly.io.orca.config.default_width` if engine is "orca"
262+
- `plotly.io.defaults.default_width` if engine is "kaleido"
263+
- `plotly.io.orca.config.default_width` if engine is "orca" (deprecated)
264264
265265
height: int or None
266266
The height of the exported image in layout pixels. If the `scale`
267267
property is 1.0, this will also be the height of the exported image
268268
in physical pixels.
269269
270270
If not specified, will default to:
271-
- `plotly.io.defaults.default_height` or `plotly.io.kaleido.scope.default_height` if engine is "kaleido"
272-
- `plotly.io.orca.config.default_height` if engine is "orca"
271+
- `plotly.io.defaults.default_height` if engine is "kaleido"
272+
- `plotly.io.orca.config.default_height` if engine is "orca" (deprecated)
273273
274274
scale: int or float or None
275275
The scale factor to use when exporting the figure. A scale factor
@@ -278,14 +278,14 @@ def to_image(
278278
less than 1.0 will decrease the image resolution.
279279
280280
If not specified, will default to:
281-
- `plotly.io.defaults.default_scale` or `plotly.io.kaleido.scope.default_scale` if engine is "kaleido"
282-
- `plotly.io.orca.config.default_scale` if engine is "orca"
281+
- `plotly.io.defaults.default_scale` if engine is "kaleido"
282+
- `plotly.io.orca.config.default_scale` if engine is "orca" (deprecated)
283283
284284
validate: bool
285285
True if the figure should be validated before being converted to
286286
an image, False otherwise.
287287
288-
engine: str
288+
engine (deprecated): str
289289
Image export engine to use. This parameter is deprecated and Orca engine support will be
290290
dropped in the next major Plotly version. Until then, the following values are supported:
291291
- "kaleido": Use Kaleido for image export
@@ -433,31 +433,31 @@ def write_image(
433433
- 'webp'
434434
- 'svg'
435435
- 'pdf'
436-
- 'eps' (Kaleido v0.* only) (Requires the poppler library to be installed and on the PATH)
436+
- 'eps' (deprecated) (Requires the poppler library to be installed and on the PATH)
437437
438438
If not specified and `file` is a string then this will default to the
439439
file extension. If not specified and `file` is not a string then this
440440
will default to:
441-
- `plotly.io.defaults.default_format` or `plotly.io.kaleido.scope.default_format` if engine is "kaleido"
442-
- `plotly.io.orca.config.default_format` if engine is "orca"
441+
- `plotly.io.defaults.default_format` if engine is "kaleido"
442+
- `plotly.io.orca.config.default_format` if engine is "orca" (deprecated)
443443
444444
width: int or None
445445
The width of the exported image in layout pixels. If the `scale`
446446
property is 1.0, this will also be the width of the exported image
447447
in physical pixels.
448448
449449
If not specified, will default to:
450-
- `plotly.io.defaults.default_width` or `plotly.io.kaleido.scope.default_width` if engine is "kaleido"
451-
- `plotly.io.orca.config.default_width` if engine is "orca"
450+
- `plotly.io.defaults.default_width` if engine is "kaleido"
451+
- `plotly.io.orca.config.default_width` if engine is "orca" (deprecated)
452452
453453
height: int or None
454454
The height of the exported image in layout pixels. If the `scale`
455455
property is 1.0, this will also be the height of the exported image
456456
in physical pixels.
457457
458458
If not specified, will default to:
459-
- `plotly.io.defaults.default_height` or `plotly.io.kaleido.scope.default_height` if engine is "kaleido"
460-
- `plotly.io.orca.config.default_height` if engine is "orca"
459+
- `plotly.io.defaults.default_height` if engine is "kaleido"
460+
- `plotly.io.orca.config.default_height` if engine is "orca" (deprecated)
461461
462462
scale: int or float or None
463463
The scale factor to use when exporting the figure. A scale factor
@@ -466,14 +466,14 @@ def write_image(
466466
less than 1.0 will decrease the image resolution.
467467
468468
If not specified, will default to:
469-
- `plotly.io.defaults.default_scale` or `plotly.io.kaleido.scope.default_scale` if engine is "kaleido"
470-
- `plotly.io.orca.config.default_scale` if engine is "orca"
469+
- `plotly.io.defaults.default_scale` if engine is "kaleido"
470+
- `plotly.io.orca.config.default_scale` if engine is "orca" (deprecated)
471471
472472
validate: bool
473473
True if the figure should be validated before being converted to
474474
an image, False otherwise.
475475
476-
engine: str
476+
engine (deprecated): str
477477
Image export engine to use. This parameter is deprecated and Orca engine support will be
478478
dropped in the next major Plotly version. Until then, the following values are supported:
479479
- "kaleido": Use Kaleido for image export
@@ -582,8 +582,7 @@ def write_images(
582582
provided to the `fig` argument.
583583
Specify format as a `str` to apply the same format to all exported images.
584584
If not specified, and the corresponding `file` argument has a file extension, then `format` will default to the
585-
file extension. Otherwise, will default to `plotly.io.defaults.default_format`
586-
or `plotly.io.kaleido.scope.default_format`.
585+
file extension. Otherwise, will default to `plotly.io.defaults.default_format`.
587586
588587
width: int, None, or list of (int or None)
589588
The width of the exported image in layout pixels. If the `scale`
@@ -593,8 +592,7 @@ def write_images(
593592
Use a list to specify widths for each figure or dict in the list
594593
provided to the `fig` argument.
595594
Specify width as an `int` to apply the same width to all exported images.
596-
If not specified, will default to `plotly.io.defaults.default_width`
597-
or `plotly.io.kaleido.scope.default_width`.
595+
If not specified, will default to `plotly.io.defaults.default_width`.
598596
599597
height: int, None, or list of (int or None)
600598
The height of the exported image in layout pixels. If the `scale`
@@ -604,8 +602,7 @@ def write_images(
604602
Use a list to specify heights for each figure or dict in the list
605603
provided to the `fig` argument.
606604
Specify height as an `int` to apply the same height to all exported images.
607-
If not specified, will default to `plotly.io.defaults.default_height`
608-
or `plotly.io.kaleido.scope.default_height`.
605+
If not specified, will default to `plotly.io.defaults.default_height`.
609606
610607
scale: int, float, None, or list of (int, float, or None)
611608
The scale factor to use when exporting the figure. A scale factor
@@ -616,8 +613,7 @@ def write_images(
616613
Use a list to specify scale for each figure or dict in the list
617614
provided to the `fig` argument.
618615
Specify scale as an `int` or `float` to apply the same scale to all exported images.
619-
If not specified, will default to `plotly.io.defaults.default_scale`
620-
or `plotly.io.kaleido.scope.default_scale`.
616+
If not specified, will default to `plotly.io.defaults.default_scale`.
621617
622618
validate: bool or list of bool
623619
True if the figure should be validated before being converted to

0 commit comments

Comments
 (0)