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

[Doc]: Exchange step() for stairs() in the Plot types - Basic section #22277

Closed
timhoffm opened this issue Jan 21, 2022 · 4 comments · Fixed by #26233
Closed

[Doc]: Exchange step() for stairs() in the Plot types - Basic section #22277

timhoffm opened this issue Jan 21, 2022 · 4 comments · Fixed by #26233
Milestone

Comments

@timhoffm
Copy link
Member

timhoffm commented Jan 21, 2022

Documentation Link

https://matplotlib.org/devdocs/plot_types/index.html#basic

Problem

step() is quite particular and a bit difficult to understand. I assume that most step-like plots come from data where you know the step points and the values in between.

@story645
Copy link
Member

should maybe be both & the difference shown clearly?

@timhoffm
Copy link
Member Author

difference shown clearly

I don't know how to do that with the minimalistic approach of the plot types. And I assume step is rarely needed (The plot types section only shows a selection of most common (?) plots. I'd be open tomswitch to showing all, but we should be consistent in our selection.

@story645
Copy link
Member

to switch to showing all
I thought the plot types gallery was for showing all the plot types, just very briefly

The difference between stair and step is step:len(x)=len(y) and stair:len(x)=len(y)+1 which I think can be made explicit in how the variables are constructed?

@jklymak
Copy link
Member

jklymak commented Jan 21, 2022

step was just originally chosen because that is what's in the cheatsheet. 👍 to change to stairs, and probably change the cheatsheet too?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
4 participants