Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

switch version in the api docs #1691

Open
s-cork opened this issue Jul 15, 2021 · 2 comments
Open

switch version in the api docs #1691

s-cork opened this issue Jul 15, 2021 · 2 comments

Comments

@s-cork
Copy link

s-cork commented Jul 15, 2021

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.

@nicolaskruchten
Copy link
Contributor

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/

@s-cork s-cork closed this as completed Jul 15, 2021
@s-cork s-cork reopened this Jan 6, 2023
@s-cork
Copy link
Author

s-cork commented Jan 6, 2023

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants