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

Documentation updates for 5.11 #3931

Merged
merged 17 commits into from
Oct 26, 2022
Merged

Documentation updates for 5.11 #3931

merged 17 commits into from
Oct 26, 2022

Conversation

LiamConnors
Copy link
Member

@LiamConnors LiamConnors commented Oct 21, 2022

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 Docs oct Docs Oct Oct 21, 2022
@nicolaskruchten
Copy link
Contributor

Hey @LiamConnors, I've just merged your changes from doc-prod into master and also updated Plotly.js to 2.16.1 and approved the Percy snapshots, so if you want to merge the tip of master into this branch you'll have a passing build and an easier time :)

@LiamConnors
Copy link
Member Author

Hey @LiamConnors, I've just merged your changes from doc-prod into master and also updated Plotly.js to 2.16.1 and approved the Percy snapshots, so if you want to merge the tip of master into this branch you'll have a passing build and an easier time :)

Thanks @nicolaskruchten. I've done that now.

@LiamConnors LiamConnors changed the title Docs Oct Documentation updates for 5.11 Oct 24, 2022
@LiamConnors LiamConnors marked this pull request as ready for review October 24, 2022 19:54
## Basic Dumbbell Plot


Dumbbell plots are useful for demonstrating change between two sets of data points, for example, the population change for a selection of countries for two different years
Copy link
Contributor

Choose a reason for hiding this comment

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

This is a cool page, thanks for adding it!

Some feedback:

  1. Neither plot has a legend, because you're using a single trace with hardcoded colors, so there's no way of knowing what green and blue mean. I would suggest a separate trace per year and then another one for the line but hide the line from the legend.
  2. Along similar lines, it might be cool to have a third example (or a modified second example) with some lines that go the other way and that are colored red, say. Again I would make this a different trace so it can have a legend entry.

This is not blocking feedback, just something that's on my mind as I've always wanted a PX function to do this stuff :)

@nicolaskruchten nicolaskruchten merged commit d124170 into master Oct 26, 2022
@archmoj archmoj deleted the docs-oct branch March 22, 2024 15:49
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