Skip to content

Minor tweaks #3726

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

Merged
merged 1 commit into from
May 11, 2022
Merged

Minor tweaks #3726

merged 1 commit into from
May 11, 2022

Conversation

nicolaskruchten
Copy link
Contributor

@LiamConnors here are some tweaks to the docs you recently wrote, just FYI.

@nicolaskruchten nicolaskruchten changed the base branch from master to doc-prod May 11, 2022 12:38
@@ -386,12 +386,10 @@ fig.show()

_new in 5.8_

You can position and style minor ticks on a Cartesian axis using `minor`. This takes a `dict` of properties to apply to minor ticks. Available properties include: `tickmode`, `tickvals`, `tickcolor`, `ticklen`, `tickwidth`, `dtick`, `tick0`, `nticks`, `ticks`, `showgrid`, `gridcolor`, `griddash`, and `gridwidth`.
You can position and style minor ticks on a Cartesian axis using the `minor` attribute. This takes a `dict` of properties to apply to minor ticks. See the [figure reference](https://plotly.com/python/reference/layout/xaxis/#layout-xaxis-minor) for full details on the accepted keys in this dict.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

in general I don't like listing options in the prose docs, as these lists get stale. It's better to link to the reference if needed

@@ -401,7 +399,7 @@ fig = px.scatter(df, x="total_bill", y="tip", color="sex")


fig.update_xaxes(minor=dict(ticklen=6, tickcolor="black", showgrid=True))
fig.update_yaxes(minor=dict(ticks="inside"))
fig.update_yaxes(minor_ticks="inside")
Copy link
Contributor Author

Choose a reason for hiding this comment

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

when updating a single attribute or two, I try to favour 'magic underscores' like this, to remind folks this exists


```python
import plotly.express as px
df = px.data.iris()

fig = px.scatter(df, x="sepal_width", y="sepal_length", facet_col="species")
fig.update_xaxes(showgrid=True, gridwidth=1, gridcolor='LightPink', griddash='dot')
fig.update_yaxes(showgrid=True, gridwidth=1, gridcolor='LightPink')
fig.update_xaxes(gridcolor='black', griddash='dash', minor_griddash="dot")
Copy link
Contributor Author

Choose a reason for hiding this comment

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

the pink was not very attractive, and was hard to see IMO. also, showgrid is on by default in xaxes and gridwidth=1 by default. I try not to explicitly set the defaults in the docs, so folks don't think it's necessary.


```python
import plotly.express as px
df = px.data.iris()

fig = px.scatter(df, x="sepal_width", y="sepal_length", facet_col="species")
fig.update_xaxes(showgrid=True, gridwidth=1, gridcolor='LightPink', griddash='dot')
fig.update_yaxes(showgrid=True, gridwidth=1, gridcolor='LightPink')
Copy link
Contributor Author

Choose a reason for hiding this comment

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

this line wasn't really doing much for the docs so I dropped it

@@ -169,7 +169,17 @@ df = pd.read_csv('https://raw.githubusercontent.com/plotly/datasets/master/finan
df = df.loc[(df["Date"] >= "2016-07-01") & (df["Date"] <= "2016-12-01")]

fig = px.line(df, x='Date', y='AAPL.High')
fig.update_xaxes(ticks= "outside", ticklabelmode= "period", tickcolor= "black", tickwidth=2, ticklen=10, minor=dict(ticks="outside", dtick=7*24*3.6e6, tick0="2016-07-04", griddash='dot', gridcolor='pink'))
fig.update_xaxes(ticks= "outside",
Copy link
Contributor Author

Choose a reason for hiding this comment

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

this was one huuuuge line that needed breaking up into indented code.

minor=dict(
ticklen=4,
dtick=7*24*60*60*1000,
tick0="2016-07-03",
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I changed this to sundays so that when you zoom in you don't get major ticks on sundays AND minor ticks on mondays ;)

@nicolaskruchten nicolaskruchten merged commit 384a400 into doc-prod May 11, 2022
@LiamConnors
Copy link
Member

Thanks for the feedback @nicolaskruchten

@nicolaskruchten nicolaskruchten deleted the minor_tweaks branch May 11, 2022 18:44
@nicolaskruchten nicolaskruchten restored the minor_tweaks branch May 11, 2022 18:44
@nicolaskruchten nicolaskruchten deleted the minor_tweaks branch May 11, 2022 18:44
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.

None yet

2 participants