Skip to content

DOC: replaced step with stairs in basic plot types #26233

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Jul 2, 2023
Merged

DOC: replaced step with stairs in basic plot types #26233

merged 1 commit into from
Jul 2, 2023
+5 −6

Conversation

rcomer
Copy link
Member

@rcomer rcomer commented Jul 1, 2023

PR summary

Rebase of #25924 which seems to have stalled. I couldn't push directly to their branch - maybe because it's main? The git error was a bit cryptic.

Closes #25924, closes #22277. The original PR also linked #23204, though that discussion is rather more involved than just step vs stairs.

PR checklist

@rcomer
Copy link
Member Author

rcomer commented Jul 1, 2023

I should probably have looked at the plot before I pushed…

@rcomer rcomer marked this pull request as draft July 1, 2023 15:37
@rcomer
Copy link
Member Author

rcomer commented Jul 1, 2023 •
edited
Loading

Updated so it's more of a direct replacement for the step plot.

Plot from #25924:
image

Now:
image

@rcomer rcomer marked this pull request as ready for review July 1, 2023 15:59
@rcomer
replaced step with stairs in basic plot types
93d208d 
Co-authored-by: Maria Malykh <mmalykh@matplotlib-dev-srv.ru-central1.internal>
story645
story645 approved these changes Jul 2, 2023
View reviewed changes
Copy link
Member

@story645 story645 left a comment

Choose a reason for hiding this comment

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

Great as is, but how do you feel about adding a little pointer to step too -
Kinda like how pcolormesh has a little descriptor https://matplotlib.org/devdocs/plot_types/arrays/pcolormesh.html#sphx-glr-plot-types-arrays-pcolormesh-py

@rcomer
Copy link
Member Author

rcomer commented Jul 2, 2023

I’m struggling to come up with words for what to say about step. I would want it to be something quite succinct like “If you want XYZ, use step”. The USP seems to be the where parameter, which I can understand by looking at the demo, but really not sure how to describe it.

@story645
Copy link
Member

story645 commented Jul 2, 2023 •
edited
Loading

I think the note on that step demo is kinda the point - step if you know mids, stairs if you know edges. Also you're welcome to self merge w/o my note & I can put in a follow on.

@rcomer
Copy link
Member Author

rcomer commented Jul 2, 2023

Also you're welcome to self merge w/o my note & I can put in a follow on.

Thanks I think I’ll do that…

@rcomer rcomer added this to the v3.8.0 milestone Jul 2, 2023
@rcomer rcomer merged commit eaad954 into matplotlib:main Jul 2, 2023
@rcomer rcomer deleted the maria-stairs branch July 2, 2023 17:18
StefRe added a commit to StefRe/matplotlib that referenced this pull request Jul 6, 2023
@StefRe
DOC: Fix image_rotator
bb77ded 
by replacing step with stairs (follow-up to matplotlib#26233) and replacing
the second step entry with the fill_between basic plot
@StefRe StefRe mentioned this pull request Jul 6, 2023
Merged
1 task
@QuLogic QuLogic mentioned this pull request Aug 10, 2023
Closed
6 tasks
@story645 story645 mentioned this pull request Oct 25, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@story645 story645 story645 approved these changes

Assignees
No one assigned
Labels
Documentation
Projects
None yet
Milestone
v3.8.0
Development

Successfully merging this pull request may close these issues.

[Doc]: Exchange step() for stairs() in the Plot types - Basic section
2 participants
@rcomer @story645