Skip to content

FIX: Expand stairs plot-type entry intro (reattempt) - #27434

Merged
story645 merged 5 commits into
matplotlib:mainfrom
CouldNot:stairs-plot-type-entry
Dec 6, 2023
Merged

story645 merged 5 commits into
matplotlib:mainfrom
CouldNot:stairs-plot-type-entry

Conversation

@CouldNot

@CouldNot CouldNot commented Dec 4, 2023

Copy link
Copy Markdown
Contributor

PR summary

This PR takes over #27209, which had a flake 8 line length error, and is addressed here. The previous PR was closed to rebase the changes and resolve the merge issues.

Closes #27194

PR checklist

Comment thread galleries/plot_types/basic/stairs.py Outdated
Comment on lines +6 to +7
See `~matplotlib.axes.Axes.stairs` when plotting $y$ between $(x_i, x_{i+1})$.
For plotting $y$ at $x$, see `~matplotlib.axes.Axes.step`.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Um the mathtext isn't rendering as math text, so you may need to use the math directive https://sphinx-gallery.github.io/stable/auto_examples/plot_0_sin.html

@CouldNot

CouldNot commented Dec 5, 2023

Copy link
Copy Markdown
Contributor Author

Hi something like this? Sorry not too familiar with sphinx.

@story645 story645 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

One last thing, otherwise looks good. You can check the output of the sphinx in the ci runs - look for "view the built docs".

Comment thread galleries/plot_types/basic/stairs.py Outdated
Co-authored-by: hannah <story645@gmail.com>
@story645 story645 added this to the v3.8-doc milestone Dec 6, 2023
@story645 story645 added the Documentation: plot types files in galleries/plot_types label Dec 6, 2023

@story645 story645 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks for the contribution, hope to see you again!

@story645
story645 merged commit d892f43 into matplotlib:main Dec 6, 2023
meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request Dec 6, 2023
meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request Dec 6, 2023
rcomer added a commit that referenced this pull request Dec 6, 2023
…434-on-v3.8.2-doc

Backport PR #27434 on branch v3.8.2-doc (FIX: Expand stairs plot-type entry intro (reattempt))
rcomer added a commit that referenced this pull request Dec 6, 2023
…434-on-v3.8.x

Backport PR #27434 on branch v3.8.x (FIX: Expand stairs plot-type entry intro (reattempt))
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation: plot types files in galleries/plot_types

Projects

None yet

Development

Successfully merging this pull request may close these issues.

DOC: Point to step in stairs plot-type entry

2 participants