Skip to content
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

[Doc]: FancyBboxPatch shows a wrong type hint for xy parameter. #26222

Closed
Geometrein opened this issue Jun 30, 2023 · 2 comments · Fixed by #26237
Closed

[Doc]: FancyBboxPatch shows a wrong type hint for xy parameter. #26222

Geometrein opened this issue Jun 30, 2023 · 2 comments · Fixed by #26237
Labels
Documentation
Milestone
v3.7-doc

Comments

@Geometrein
Copy link
Contributor

Documentation Link

https://matplotlib.org/stable/api/_as_gen/matplotlib.patches.FancyBboxPatch.html

Problem

FancyBboxPatch shows float as the suggested type for xy parameter. However 'xy' should be a tuple of two floats. Seem like it is caused by missing parenthesis.

Suggested improvement

Change the type hint form xy: float, float to xy: (float, float)
@QuLogic
Copy link
Member

QuLogic commented Jun 30, 2023

That sounds correct; would you like to open a PR?

@Geometrein
Copy link
Contributor Author

Sure, will do!

@Geometrein Geometrein mentioned this issue Jul 3, 2023
Merged
2 tasks
@QuLogic QuLogic added this to the v3.7-doc milestone Jul 4, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Documentation
Projects
None yet
Milestone
v3.7-doc
Development

Successfully merging a pull request may close this issue.

Update FancyBboxPatch docstring
2 participants
@QuLogic @Geometrein