documentation icon indicating copy to clipboard operation
documentation copied to clipboard

switch version in the api docs

Open s-cork opened this issue 4 years ago • 2 comments

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.

s-cork avatar Jul 15 '21 12:07 s-cork

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/

nicolaskruchten avatar Jul 15 '21 13:07 nicolaskruchten

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.

s-cork avatar Jan 06 '23 04:01 s-cork