Skip to content

Make the signature of Axes.draw() consistent with Artist.draw(). #16063

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
Mar 9, 2020

Conversation

anntzer
Copy link
Contributor

@anntzer anntzer commented Jan 1, 2020

... i.e. draw(renderer) instead of draw(renderer=None, inframe=False)
(with a deprecation period).

Closes #16022.

PR Summary

PR Checklist

  • Has Pytest style unit tests
  • Code is Flake 8 compliant
  • New features are documented, with examples if plot related
  • Documentation is sphinx and numpydoc compliant
  • Added an entry to doc/users/next_whats_new/ if major new feature (follow instructions in README.rst there)
  • Documented in doc/api/api_changes.rst if API changed in a backward-incompatible way

@anntzer anntzer force-pushed the drawsig branch 2 times, most recently from b226b07 to a663528 Compare January 1, 2020 19:03
@anntzer anntzer added this to the v3.3.0 milestone Jan 13, 2020
@anntzer anntzer force-pushed the drawsig branch 3 times, most recently from a500415 to 18a1b67 Compare January 14, 2020 00:37
@anntzer anntzer force-pushed the drawsig branch 2 times, most recently from b5a493c to 32b5da6 Compare January 25, 2020 12:57
Copy link
Member

@QuLogic QuLogic left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Needs a rebase and a small typo fix.

def draw(self, renderer=None, inframe=False):
# docstring inherited
if renderer is None:
cbook.warn_deprecated(
"3.3", message="Support for not passing the 'renderer' "
"paramater to Axes.draw() is deprecated since %(since)s and "
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"paramater to Axes.draw() is deprecated since %(since)s and "
"parameter to Axes.draw() is deprecated since %(since)s and "

@@ -323,6 +323,8 @@ def _delete_parameter(since, name, func=None):
such after the deprecation period has passed and the deprecated parameter
is removed.

Additional kwargs are passed to `.warn_deprecated`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Additional kwargs are passed to `.warn_deprecated`.
Additional keyword arguments are passed to `.warn_deprecated`.

... i.e. draw(renderer) instead of draw(renderer=None, inframe=False)
(with a deprecation period).
@anntzer
Copy link
Contributor Author

anntzer commented Mar 9, 2020

thanks, rebased and handled comments.

@timhoffm timhoffm merged commit 436eb4a into matplotlib:master Mar 9, 2020
@anntzer anntzer deleted the drawsig branch March 9, 2020 13:22
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.

Cleanup Artist.draw() signatures
3 participants