plotly.py
plotly.py copied to clipboard
Doc - Configuration-options - improvement propositions
Here some improvement propositions as I am going through the docs:
-
Add missing
fig.show()in second exemple of Removing Modebar Buttons and Add optional shape-drawing buttons to modebar -
Modify
config = dict({'scrollZoom': True})toconfig = {'scrollZoom': True}in Enabling Scroll Zoom -
Remove unused
import plotly.graph_objects as goin the two examples in Add optional shape-drawing buttons to modebar -
Remove #L6 from hyperlink https://github.com/plotly/plotly.js/blob/master/src/plot_api/plot_config.js#L6 in Reference
(nothing special on line 6)
-
Add/remove spaces and new lines for syntax and consistency
Documentation PR
- [x] I've seen the
doc/README.mdfile - [x] This change runs in the current version of Plotly on PyPI and targets the
doc-prodbranch OR it targets themasterbranch - [ ] If this PR modifies the first example in a page or adds a new one, it is a
pxexample if at all possible - [x] Every new/modified example has a descriptive title and motivating sentence or paragraph
- [x] Every new/modified example is independently runnable
- [x] 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
- [x] Imports are
plotly.graph_objects as go/plotly.express as px/plotly.io as pio - [x] Data frames are always called
df - [x]
fig = <something>call is high up in each new/modified example (eitherpx.<something>ormake_subplotsorgo.Figure) - [x] Liberal use is made of
fig.add_*andfig.update_*rather thango.Figure(data=..., layout=...)in every new/modified example - [ ] Specific adders and updaters like
fig.add_shapeandfig.update_xaxesare used instead of bigfig.update_layoutcalls in every new/modified example - [x]
fig.show()is at the end of each new/modified example - [x]
plotly.plot()andplotly.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