Skip to content

Fixes row/column mixup in GridSpec height_ratios documentation. #21787

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

Merged
merged 1 commit into from
Nov 29, 2021
Merged

Fixes row/column mixup in GridSpec height_ratios documentation. #21787

merged 1 commit into from
Nov 29, 2021

Conversation

cgevans
Copy link
Contributor

@cgevans cgevans commented Nov 29, 2021

PR Summary

Documentation for height_ratios in GridSpec.init uses "column" where it should use "row", one of the uses of column likely having escaped from changes when adapting the width_ratios documentation to height_ratios. This fixes the mixup.

PR Checklist

(This is a one-word change to documentation.)

Tests and Styling

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

Documentation

  • [N/A] New features are documented, with examples if plot related.
  • [N/A] New features have an entry in doc/users/next_whats_new/ (follow instructions in README.rst there).
  • [N/A] API changes documented in doc/api/next_api_changes/ (follow instructions in README.rst there).
  • [N/A] Documentation is sphinx and numpydoc compliant (the docs should build without error).

Documentation for height_ratios in GridSpec.__init__ uses "column" where it should use "row".  This fixes the mixup.
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.

@jklymak jklymak added this to the v3.5.1 milestone Nov 29, 2021
@jklymak jklymak merged commit 54cf7bc into matplotlib:main Nov 29, 2021
meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request Nov 29, 2021
@jklymak
Copy link
Member

jklymak commented Nov 29, 2021

Thanks again - I checked I don't think there are any more of these!

jklymak added a commit that referenced this pull request Nov 29, 2021
…787-on-v3.5.x

Backport PR #21787 on branch v3.5.x (Fixes row/column mixup in GridSpec height_ratios documentation.)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants