8000 Add Plotly.js docs updates for 6.3 by LiamConnors · Pull Request #5269 · plotly/plotly.py · GitHub
[go: up one dir, main page]
Skip to content

Add Plotly.js docs updates for 6.3 #5269

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.

Sign up for GitHub

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

Jump to bottom
Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
Draft

Add Plotly.js docs updates for 6.3 #5269

wants to merge 3 commits into from

Conversation

LiamConnors
Copy link
Member
@LiamConnors LiamConnors commented Jul 7, 2025 •
edited
Loading

Adds examples for next Plotly.js version

Documentation PR

  • I have 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 main 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.
  • 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, and/or plotly.io as pio.
  • Data frames are always called df.
  • fig = <something> is called 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=...).
  • Specific adders and updaters like fig.add_shape and fig.update_xaxes are used instead of big fig.update_layout calls.
  • fig.show() is at the end of each example.
  • plotly.plot() and plotly.iplot() are not used in any example.
  • Named colors are used instead of hex codes wherever possible.
  • Code blocks are marked with &#96;&#96;&#96;python.

@gvwilson gvwilson added feature something new P1 needed for current cycle documentation written for humans labels Jul 8, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@LiamConnors LiamConnors

Labels
documentation written for humans feature something new P1 needed for current cycle
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@LiamConnors @gvwilson
0