Skip to content

Update plotly.js to 2.24.1 and add docs for new features #4210

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

Merged
merged 26 commits into from
Jun 7, 2023

Conversation

LiamConnors
Copy link
Member

@LiamConnors LiamConnors commented May 15, 2023

Documentation PR

  • I've seen the doc/README.md file
  • This change runs in the current version of Plotly on PyPI and targets the doc-prod branch OR it targets the master branch
  • If this PR modifies the first example in a page or adds a new one, it is a px example if at all possible
  • Every new/modified example has a descriptive title and motivating sentence or paragraph
  • Every new/modified example is independently runnable
  • Every new/modified example is optimized for short line count and focuses on the Plotly/visualization-related aspects of the example rather than the computation required to produce the data being visualized
  • Meaningful/relatable datasets are used for all new examples instead of randomly-generated data where possible
  • The random seed is set if using randomly-generated data in new/modified examples
  • New/modified remote datasets are loaded from https://plotly.github.io/datasets and added to https://github.com/plotly/datasets
  • Large computations are avoided in the new/modified examples in favour of loading remote datasets that represent the output of such computations
  • Imports are plotly.graph_objects as go / plotly.express as px / plotly.io as pio
  • Data frames are always called df
  • fig = <something> call is high up in each new/modified example (either px.<something> or make_subplots or go.Figure)
  • Liberal use is made of fig.add_* and fig.update_* rather than go.Figure(data=..., layout=...) in every new/modified example
  • Specific adders and updaters like fig.add_shape and fig.update_xaxes are used instead of big fig.update_layout calls in every new/modified example
  • fig.show() is at the end of each new/modified example
  • plotly.plot() and plotly.iplot() are not used in any new/modified example
  • Hex codes for colors are not used in any new/modified example in favour of these nice ones

Code PR

  • I have read through the contributing notes and understand the structure of the package. In particular, if my PR modifies code of plotly.graph_objects, my modifications concern the codegen files and not generated files.
  • I have added tests (if submitting a new feature or correcting a bug) or
    modified existing tests.
  • For a new feature, I have added documentation examples in an existing or
    new tutorial notebook (please see the doc checklist as well).
  • I have added a CHANGELOG entry if fixing/changing/adding anything substantial.
  • For a new feature or a change in behaviour, I have updated the relevant docstrings in the code to describe the feature or behaviour (please see the doc checklist as well).

-->

@LiamConnors LiamConnors changed the title Update plotly js to 2.23.0 Update plotly.js to 2.23.0 May 15, 2023
@LiamConnors LiamConnors changed the title Update plotly.js to 2.23.0 Update plotly.js to 2.23.1 and add docs for new features May 17, 2023
@LiamConnors LiamConnors marked this pull request as ready for review May 17, 2023 14:15
@LiamConnors LiamConnors requested a review from archmoj May 17, 2023 14:15
@archmoj
Copy link
Contributor

archmoj commented May 17, 2023

Excellent. Thank you @LiamConnors 🥇
💃

Copy link
Collaborator

@alexcjohnson alexcjohnson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💃

@alexcjohnson
Copy link
Collaborator

Looks like the release_build job is failing due to jupyterlab 4 updates?

@LiamConnors
Copy link
Member Author

Looks like the release_build job is failing due to jupyterlab 4 updates?

Yeah, looks like something to do with that.

@alexcjohnson alexcjohnson mentioned this pull request May 19, 2023
1 task

*New in 5.15*

Pie charts support [patterns](/python/pattern-hatching-texture/) (also known as hatching or texture) in addition to color.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's have similar minimal examples for funnelarea, icicle, sunburst and treemap.
Thank you!

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added

@archmoj archmoj changed the title Update plotly.js to 2.23.1 and add docs for new features Update plotly.js to 2.24.0 and add docs for new features Jun 6, 2023
@LiamConnors
Copy link
Member Author

@alexcjohnson and @archmoj this is ready for another look. I've updated to Plotly.js 2.24.0 and added examples for patterns for the new trace types. Lots of formatting changes applied by the code generator. Not sure why.

@archmoj
Copy link
Contributor

archmoj commented Jun 7, 2023

🥇 Looking very good to me.
Thank you 🙏 @LiamConnors

@LiamConnors
Copy link
Member Author

🥇 Looking very good to me. Thank you 🙏 @LiamConnors

Thanks @archmoj.
Some strange behaviour happening with the docs build. Seems unrelated to this PR. Investigating.

Copy link
Collaborator

@alexcjohnson alexcjohnson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💃 after updating the changelog

Co-authored-by: Alex Johnson <[email protected]>
@LiamConnors LiamConnors changed the title Update plotly.js to 2.24.0 and add docs for new features Update plotly.js to 2.24.1 and add docs for new features Jun 7, 2023
@LiamConnors LiamConnors merged commit 2d055a4 into master Jun 7, 2023
@LiamConnors LiamConnors deleted the update-plotly-js branch June 7, 2023 22:41
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

Successfully merging this pull request may close these issues.

3 participants