Skip to content

DOC: Point to step in stairs plot-type entry #27194

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
Closed
story645 opened this issue Oct 25, 2023 · 4 comments · Fixed by #27434
Closed

DOC: Point to step in stairs plot-type entry #27194

story645 opened this issue Oct 25, 2023 · 4 comments · Fixed by #27434
Labels
Documentation: plot types files in galleries/plot_types Good first issue Open a pull request against these issues if there are no active ones!
Milestone
v3.8-doc

Comments

@story645
Copy link
Member

story645 commented Oct 25, 2023 •
edited
Loading

I think we could make stairs/step a bit easier to navigate by adding a drop of roadmapping by changing the intro sentence in the stairs plot type entry:

matplotlib/galleries/plot_types/basic/stairs.py

Line 6 in 879cf76

See `~matplotlib.axes.Axes.stairs`.

to something that sets expectations for stairs and points folks to steps when appropriate. Something like:

See `~matplotlib.axes.Axes.stairs` when plotting $y$ between $(x_i, x_{i+1})$ and ~`matplotlib.axes.Axes.step` when plotting $y$ at $x$.

Kinda like how pcolormesh has a little descriptor https://matplotlib.org/devdocs/plot_types/arrays/pcolormesh.html#sphx-glr-plot-types-arrays-pcolormesh-py
Originally posted by @story645 in #26233 (review)
@story645 story645 added Documentation: plot types files in galleries/plot_types Good first issue Open a pull request against these issues if there are no active ones! labels Oct 25, 2023
@github-actions
Copy link

Good first issue - notes for new contributors

This issue is suited to new contributors because it does not require understanding of the Matplotlib internals. To get started, please see our contributing guide.

We do not assign issues. Check the Development section in the sidebar for linked pull requests (PRs). If there are none, feel free to start working on it. If there is an open PR, please collaborate on the work by reviewing it rather than duplicating it in a competing PR.

If something is unclear, please reach out on any of our communication channels.

@ascodeasice
Copy link

Hi, can I work on this issue?

@story645
Copy link
Member Author

Go for it!

@CouldNot CouldNot mentioned this issue Oct 26, 2023
Closed
2 tasks
spandan0724 added a commit to spandan0724/matplotlib that referenced this issue Oct 28, 2023
@spandan0724
DOC: Direct to the entry regarding the 'step' function within the 'st…
ac7bef2 
…airs' plot type, identified by matplotlib#27194.
@pat8901
Copy link
Contributor

pat8901 commented Nov 26, 2023

I've reviewed the linked pull request, and I'm uncertain about the current status, whether the issue is still open or if the pull request is awaiting review. Could someone with more information provide an update?

@CouldNot CouldNot mentioned this issue Dec 4, 2023
Merged
2 tasks
@QuLogic QuLogic added this to the v3.8-doc milestone Dec 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Documentation: plot types files in galleries/plot_types Good first issue Open a pull request against these issues if there are no active ones!
Projects
None yet
Milestone
v3.8-doc
4 participants
@QuLogic @story645 @ascodeasice @pat8901