plotly.py icon indicating copy to clipboard operation
plotly.py copied to clipboard

`to_image` documentation incorrect

Open Paecificjr opened this issue 1 year ago • 0 comments

It currently says:

scale: int or float or None
    The scale factor to use when exporting the figure. A scale factor larger than 1.0 will increase the image resolution with respect to the figure's layout pixel dimensions. Whereas as scale factor of less than 1.0 will decrease the image resolution.

    If not specified, will default to plotly.io.config.default_scale

https://github.com/plotly/plotly.py/blob/99e63da4df59a6cad4e7ea42583f292150db9e18/packages/python/plotly/plotly/io/_orca.py#L1426-L1432

https://github.com/plotly/plotly.py/blob/99e63da4df59a6cad4e7ea42583f292150db9e18/packages/python/plotly/plotly/basedatatypes.py#L3753-L3759

However, something has been changed and these blocks should match the documentation in _kaleido.py

https://github.com/plotly/plotly.py/blob/99e63da4df59a6cad4e7ea42583f292150db9e18/packages/python/plotly/plotly/io/_kaleido.py#L67-L75

Paecificjr avatar Dec 08 '23 04:12 Paecificjr