NotificationsYou must be signed in to change notification settings
Fork7.9k
Star21.4k

Tweak argument checking in tripcolor().#22883

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Jump to bottom

Merged

oscargus merged 1 commit intomatplotlib:mainfromanntzer:tca

Apr 24, 2022

Merged

Tweak argument checking in tripcolor().#22883

oscargus merged 1 commit intomatplotlib:mainfromanntzer:tca

Apr 24, 2022

Conversation

Copy link

Contributor

anntzer commentedApr 23, 2022•
edited
Loading

For incorrect number of parameters, switch to raising a (standard)
TypeError and use a standard-ish signature mismatch error message. Note
that exception type stability was already broken in 3.6 because it was
previously an IndexError (that was triggered later) and703b574 changed
that to a ValueError.

Also deprecate support for passing extra parameters (as we now tend to
do for all such overly accepting APIs). Note that the changelog entry
states that such parameters were previously silently ignored, even
though the patch replaces a warn_external() by a warn_deprecated(); this
is simply because the warn_external() wasn't present yet in the last
released version.

Alsocloses#22882.

PR Summary

PR Checklist

Tests and Styling

Has pytest style unit tests (andpytest passes).
IsFlake 8 compliant (installflake8-docstrings and runflake8 --docstring-convention=all).

Documentation

New features are documented, with examples if plot related.
New features have an entry indoc/users/next_whats_new/ (follow instructions in README.rst there).
API changes documented indoc/api/next_api_changes/ (follow instructions in README.rst there).
Documentation is sphinx and numpydoc compliant (the docs shouldbuild without error).

anntzer added the API: argument checking label

Apr 23, 2022

anntzer added this to thev3.6.0 milestone

Apr 23, 2022

Tweak argument checking in tripcolor().

7db1913

For incorrect number of parameters, switch to raising a (standard)TypeError and use a standard-ish signature mismatch error message.  Notethat exception type stability was already broken in 3.6 because it waspreviously an IndexError (that was triggered later) and703b574 changedthat to a ValueError.Also deprecate support for passing extra parameters (as we now tend todo for all such overly accepting APIs).  Note that the changelog entrystates that such parameters were previously silently ignored, eventhough the patch replaces a warn_external() by a warn_deprecated(); thisis simply because the warn_external() wasn't present yet in the lastreleased version.