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

Next release docs updates + upgrade plotly.js version #4294

Merged
merged 14 commits into from
Aug 11, 2023

Conversation

LiamConnors
Copy link
Member

@LiamConnors LiamConnors commented Jul 24, 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

@LiamConnors LiamConnors requested a review from archmoj July 24, 2023 17:17
@archmoj
Copy link
Contributor

archmoj commented Jul 25, 2023

Excellent.
Thanks @LiamConnors
💃

doc/python/legend.md Outdated Show resolved Hide resolved
@LiamConnors LiamConnors changed the title WIP Shapes in Legends docs Add Shapes in Legends docs + upgrade plotly.js version Jul 25, 2023
@LiamConnors LiamConnors changed the title Add Shapes in Legends docs + upgrade plotly.js version Next release docs updates + upgrade plotly.js version Jul 25, 2023
@LiamConnors LiamConnors marked this pull request as ready for review July 25, 2023 17:53
@LiamConnors
Copy link
Member Author

@archmoj @alexcjohnson sounds like plotly/plotly.js#6679 wouldn't be accessible in Plotly.py. Is that correct? I didn't add anything for it here.

@alexcjohnson
Copy link
Collaborator

sounds like plotly/plotly.js#6679 wouldn't be accessible in Plotly.py. Is that correct?

That's correct, Plotly.deleteActiveShape is useful in Dash and plain Plotly.js but not Plotly.py

@LiamConnors
Copy link
Member Author

Docs for autoranges on a separate PR:
#4307

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.

💃

@LiamConnors LiamConnors merged commit ee1279a into master Aug 11, 2023
@LiamConnors LiamConnors deleted the next-release-docs branch August 11, 2023 18:37
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