Skip to content

Add explanatory comments to "broken" horizontal bar plot example #22030

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 2 commits into from
Dec 24, 2021
Merged

Add explanatory comments to "broken" horizontal bar plot example #22030

merged 2 commits into from
Dec 24, 2021

Conversation

ruthgn
Copy link
Contributor

@ruthgn ruthgn commented Dec 21, 2021

PR Summary

This pull request adds explanatory comments to the "broken" horizontal bar plot example. PR related to issue #11654.

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).

Update broken_barh.py
0eba9e4 
Add explanatory comments for "broken" horizontal bar plot example
github-actions[bot]
github-actions bot reviewed Dec 21, 2021
View reviewed changes
Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Thank you for opening your first PR into Matplotlib!

If you have not heard from us in a while, please feel free to ping @matplotlib/developers or anyone who has commented on the PR. Most of our reviewers are volunteers and sometimes things fall through the cracks.

You can also join us on gitter for real-time discussion.

For details on testing, writing docs, and our review process, please see the developer guide

We strive to be a welcoming and open project. Please follow our Code of Conduct.

@tacaswell tacaswell modified the milestones: v3.5.2, v3.6.0 Dec 21, 2021
@tacaswell
Copy link
Member

Thank you @ruthgn !

I am 👍 on the content (it explains why those lines are there), but the linter is not happy (need more space between the code and the in-line comment). I think this might look a little better if both # are vertically aligned and pushed pretty far out to the left like

some_long_verbose_code    # comment
srt_cd                    # other comment

Update broken_barh.py
f7602dd 
Make explanatory comments vertically aligned
@jklymak jklymak merged commit acadcdb into matplotlib:main Dec 24, 2021
@jklymak
Copy link
Member

jklymak commented Dec 24, 2021

Thanks for the contribution!

@ruthgn ruthgn deleted the pr/22027 branch January 2, 2022 17:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@github-actions github-actions[bot] github-actions[bot] left review comments

@tacaswell tacaswell tacaswell approved these changes

@jklymak jklymak jklymak approved these changes

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

Successfully merging this pull request may close these issues.
4 participants
@ruthgn @tacaswell @jklymak @QuLogic