Skip to content

Expire parameter renaming and deletion and attribute privatization from 3.5 #23874

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

Closed
wants to merge 1 commit into from

Conversation

oscargus
Copy link
Member

@oscargus oscargus commented Sep 11, 2022

PR Summary

Will add a (quite long) release note.

Skipped widgets.py as it was a bit confusing at stages. But apart from that all renaming, deletion and privatization should be gone.

PR Checklist

Tests and Styling

  • [N/A] Has pytest style unit tests (and pytest passes).
  • Is Flake 8 compliant (install flake8-docstrings and run flake8 --docstring-convention=all).

Documentation

  • [N/A] New features are documented, with examples if plot related.
  • [N/A] 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).

@@ -468,8 +467,7 @@ def _print_pil(self, filename_or_obj, fmt, pil_kwargs, metadata=None):
filename_or_obj, self.buffer_rgba(), format=fmt, origin="upper",
dpi=self.figure.dpi, metadata=metadata, pil_kwargs=pil_kwargs)

@_api.delete_parameter("3.5", "args")
def print_png(self, filename_or_obj, *args,
def print_png(self, filename_or_obj,
Copy link
Contributor

@anntzer anntzer Sep 11, 2022

Choose a reason for hiding this comment

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

Once you expire a delete_parameter, all subsequent parameters also become kwonly (as it was impossible to pass them positionally during the deprecation period without triggering the deprecation). Ditto for all other instances below.

Copy link
Member Author

Choose a reason for hiding this comment

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

I was thinking about that. Makes sense!

@QuLogic
Copy link
Member

QuLogic commented Sep 12, 2022

For the removal notes, please add a bit more context than last time. When X is removed from Y where Y is 3 levels deep in an import tree, it is very hard to tell whether it's a relevant thing. See the changes in #23814 for examples.

@oscargus
Copy link
Member Author

I've realized that the release notes is really the problem here. It may be that I close this and do parts gradually as for some of these I do not really have much context and the earlier notes does not give much info either.

@oscargus
Copy link
Member Author

oscargus commented Oct 8, 2022

Closing this as it must be done in steps to be manageable.

@oscargus oscargus closed this Oct 8, 2022
@oscargus oscargus deleted the remove35parameters branch October 8, 2022 07:49
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.

3 participants