Skip to content

Stairsplottype #23311

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

Closed
wants to merge 3 commits into from
Closed

Stairsplottype #23311

wants to merge 3 commits into from

Conversation

kkoutris
Copy link

@kkoutris kkoutris commented Jun 20, 2022

PR Summary

Added new plot type(stairs) to the documentation as asked by #23204.

PR Checklist

Tests and Styling

  • Has pytest style unit tests (and pytest passes).
  • Is Flake 8 compliant (install flake8-docstrings and run flake8 --docstring-convention=all).

Documentation

  • New features are documented, with examples if plot related.
  • New features have an entry in doc/users/next_whats_new/ (follow instructions in README.rst there).
  • API changes documented in doc/api/next_api_changes/ (follow instructions in README.rst there).
  • Documentation is sphinx and numpydoc compliant (the docs should build without error).
    Add stairs plot type to the documentation as asked from [Doc]: More plot types? #23204

Copy link
Member

@jklymak jklymak left a comment

Choose a reason for hiding this comment

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

Thanks for this!

OTOH I don't think we should have both stairs and steps. This should also be accompanied by a change to the cheatsheet if the stairs is really the preferred grammar here.

@@ -185,7 +185,7 @@ def update_text(self):
r = s / 2
if self.textposition == "inside":
r = s / np.interp(angle_span, [60, 90, 135, 180],
[3.3, 3.5, 3.8, 4])
[10, 3.5, 11.4, 4])
Copy link
Member

Choose a reason for hiding this comment

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

Unrelated change?

Comment on lines +2 to +4
==========
stairs(x, y)
==========
Copy link
Member

Choose a reason for hiding this comment

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

Docs won't build if formatting is incorrect: /home/circleci/project/doc/plot_types/basic/stairs.rst:24: WARNING: Title overline too short.

Suggested change
==========
stairs(x, y)
==========
============
stairs(x, y)
============

ax.set(xlim=(0, 8), xticks=np.arange(1, 8),
ylim=(0, 8), yticks=np.arange(1, 8))

plt.show()
Copy link
Member

Choose a reason for hiding this comment

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

We need the extra line for our linting.

@jklymak jklymak marked this pull request as draft June 23, 2022 08:36
@jklymak
Copy link
Member

jklymak commented Jun 23, 2022

I'll move to draft for now - feel free to move to ready when you have a chance to address..

@QuLogic
Copy link
Member

QuLogic commented Aug 10, 2023

I think this has been replaced by #26233. Thank you for your effort @kkoutris; we're sorry that this was not accepted, but we hope to hear from you again.

@QuLogic QuLogic closed this Aug 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Development

Successfully merging this pull request may close these issues.

3 participants