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

Improve Periodic-table-example #3489

Merged
merged 3 commits into from
Dec 20, 2021
Merged

Improve Periodic-table-example #3489

merged 3 commits into from
Dec 20, 2021

Conversation

janosh
Copy link
Contributor

@janosh janosh commented Nov 25, 2021

Documentation PR

Improves the custom-hovertext annotated-heatmap example by hiding hover text on empty tiles and ensuring periodic table cells are squares.

  • 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
  • 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
  • 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

@janosh
Copy link
Contributor Author

janosh commented Nov 25, 2021

Now looks like this:
Screen Shot 2021-11-25 at 15 43 56

Before:
Screen Shot 2021-11-25 at 15 49 31

@nicolaskruchten
Copy link
Contributor

Thanks! I've just merged some changes to this doc file so there are now some conflicts... Sorry!

@janosh
Copy link
Contributor Author

janosh commented Dec 20, 2021

All good now.

@nicolaskruchten nicolaskruchten merged commit 6a023af into plotly:master Dec 20, 2021
@nicolaskruchten
Copy link
Contributor

Thanks!

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