Skip to content

[Doc] consolidate rect documentation #22820

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 5 commits into from
Jul 1, 2022
Merged

[Doc] consolidate rect documentation #22820

merged 5 commits into from
Jul 1, 2022

Conversation

Sync271
Copy link
Contributor

@Sync271 Sync271 commented Apr 10, 2022 •
edited
Loading

PR Summary

Consolidate rect documentation. Closes #22819

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

github-actions[bot]
github-actions bot reviewed Apr 10, 2022
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.

@oscargus
Copy link
Member

I believe that there are two cases here actually:

rect :  tuple (left, bottom, right, top)

and

rect :  tuple (left, bottom, width, height)

I would personally prefer this style (possibly with default parameter when available). Also, I think that (parts of) the explanation should be kept.

@story645
Copy link
Member

story645 commented May 19, 2022 •
edited
Loading

hi @Sync271, do you have time/interest to resolve the merge conflict and finish up this pr?

@jklymak jklymak marked this pull request as draft May 19, 2022 06:41
@Sync271
Copy link
Contributor Author

Sync271 commented May 19, 2022

hi @Sync271, do you have time/interest to resolve the merge conflict and finish up this pr?

Will do!

@story645 story645 marked this pull request as ready for review May 19, 2022 14:56
jklymak
jklymak requested changes Jun 30, 2022
View reviewed changes
Sync271 and others added 2 commits July 1, 2022 02:34
@Sync271 @jklymak
fix rect definition formatting
33a792a 
Co-Authored-By: Jody Klymak <jklymak@gmail.com>
@Sync271 @jklymak
fix trailing white space and rect definition for add_axes()
d9d9130 
Co-Authored-By: Jody Klymak <jklymak@gmail.com>
@Sync271 Sync271 requested a review from jklymak June 30, 2022 21:17
@jklymak jklymak merged commit 297feee into matplotlib:main Jul 1, 2022
@jklymak
Copy link
Member

jklymak commented Jul 1, 2022

Thanks a lot @Sync271 - I squashed your commits into one, which is our usual policy...

@QuLogic QuLogic added this to the v3.6.0 milestone Jul 4, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@QuLogic QuLogic QuLogic left review comments

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

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

[Doc]: Make rect argument consistent in the docstrings
5 participants
@Sync271 @oscargus @story645 @jklymak @QuLogic