plotly / documentation

Issue tracker for Plotly's open-source documentation.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

switch version in the api docs

s-cork opened this issue · comments

commented

Is there a way to switch version in the api docs?

https://plotly.com/python-api-reference seems to be at 5.1.0.
And there seems no way to see the api docs for a different version.
It would be useful for those that haven't yet migrated.

There is not, no, but our API is largely backwards-compatible back to 3.0 with only the changes listed in https://plotly.com/python/v4-migration/

commented

I wanted to re-open this.
Context - we currently use python version 4, and are often a version behind plotly latest.

Whilst being largely backward compatible is useful.
Not having access to api docs of previous versions can be frustrating at times.

For example, a user just pointed out that fillpattern doesn't work in our plotly implementation.
This is documented in the API docs.
But there's no obvious place I can point the user to and say:

  • yes but fillpattern isn't available in version 4, it was only added in version 5

Having a version switch in the website documentation would be so helpful for this kind of use case.