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

[MNT] fix type annotations of fignum_exists #27376

Merged
merged 3 commits into from Nov 27, 2023
Merged

[MNT] fix type annotations of fignum_exists #27376

merged 3 commits into from Nov 27, 2023

Conversation

sdiebolt
Copy link
Contributor

@sdiebolt sdiebolt commented Nov 27, 2023 •
edited

PR summary

This PR fixes the type annotation of the num argument from matplotlib.pyplot.fignum_exists (going from int to int | str). It also expands a bit the documentation to clarify parameters and return types.

PR checklist

rcomer
rcomer reviewed Nov 27, 2023
View reviewed changes
Copy link
Member

@rcomer rcomer 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 catching this @sdiebolt!

lib/matplotlib/pyplot.py Outdated Show resolved Hide resolved
oscargus
oscargus reviewed Nov 27, 2023
View reviewed changes
lib/matplotlib/pyplot.py Outdated Show resolved Hide resolved
@sdiebolt @rcomer
fix(docs): fix documentation of fignum_exists
1dc7816 
Co-authored-by: Ruth Comer <10599679+rcomer@users.noreply.github.com>
@oscargus oscargus added this to the v3.8.3 milestone Nov 27, 2023
@oscargus oscargus merged commit e2c9cd4 into matplotlib:main Nov 27, 2023
39 of 40 checks passed
@meeseeksmachine meeseeksmachine mentioned this pull request Nov 27, 2023
Merged
meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request Nov 27, 2023
@sdiebolt @meeseeksmachine
Backport PR matplotlib#27376: [MNT] fix type annotations of `fignum_e…
696ac94 
…xists`
@oscargus
Copy link
Contributor

Thanks @sdiebolt and congratulation to your first merged Matplotlib contribution! Hope to see you around!

@oscargus oscargus added topic: typing Documentation: API files in lib/ and doc/api labels Nov 27, 2023
rcomer added a commit that referenced this pull request Nov 27, 2023
@rcomer
Merge pull request #27379 from meeseeksmachine/auto-backport-of-pr-27…
25d096f 
…376-on-v3.8.x

Backport PR #27376 on branch v3.8.x ([MNT] fix type annotations of `fignum_exists`)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@oscargus oscargus oscargus approved these changes

@rcomer rcomer rcomer approved these changes

Assignees
No one assigned
Labels
Documentation: API files in lib/ and doc/api topic: typing
Projects
None yet
Milestone
v3.8.3
Development

Successfully merging this pull request may close these issues.

[MNT]: Type annotations for fignum_exists should allow strings
3 participants
@sdiebolt @oscargus @rcomer