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

Update plotly.js to v2.34.0 + add docs #4627

Merged
merged 20 commits into from
Jul 22, 2024
Merged

Conversation

LiamConnors
Copy link
Member

@LiamConnors LiamConnors commented Jun 5, 2024

#4629

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 marked this pull request as ready for review June 12, 2024 20:32
@archmoj
Copy link
Contributor

archmoj commented Jun 12, 2024

Thanks for the PR. @LiamConnors

Have you included this code change?f1522cd

@LiamConnors
Copy link
Member Author

Thanks for the PR. @LiamConnors

Have you included this code change?f1522cd

Not yet. I'll include it after you merge your PR

doc/python/axes.md Outdated Show resolved Hide resolved
@archmoj archmoj changed the title Update plotly.js to v2.33.0 + add docs Update plotly.js to v2.34.0 + add docs Jul 18, 2024
@LiamConnors
Copy link
Member Author

@emilykl @archmoj this is ready for review

@archmoj
Copy link
Contributor

archmoj commented Jul 18, 2024

@LiamConnors
Please also add an example for this PR: plotly/plotly.js#7043.
Thank you!

Copy link
Contributor

@archmoj archmoj left a comment

Choose a reason for hiding this comment

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

💃
Nicely done.

@LiamConnors LiamConnors merged commit 9b5ec6a into master Jul 22, 2024
5 checks passed
@LiamConnors LiamConnors deleted the update-plotly-js-version branch July 22, 2024 19:03
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.

2 participants