Doc - Configuration-options - improvement propositions #3861
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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 modebarModify
config = dict({'scrollZoom': True})
toconfig = {'scrollZoom': True}
in Enabling Scroll ZoomRemove unused
import plotly.graph_objects as go
in the two examples in Add optional shape-drawing buttons to modebarRemove #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
doc/README.md
filedoc-prod
branch OR it targets themaster
branchpx
example if at all possibleplotly.graph_objects as go
/plotly.express as px
/plotly.io as pio
df
fig = <something>
call is high up in each new/modified example (eitherpx.<something>
ormake_subplots
orgo.Figure
)fig.add_*
andfig.update_*
rather thango.Figure(data=..., layout=...)
in every new/modified examplefig.add_shape
andfig.update_xaxes
are used instead of bigfig.update_layout
calls in every new/modified examplefig.show()
is at the end of each new/modified exampleplotly.plot()
andplotly.iplot()
are not used in any new/modified example