Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Cleanup wx docstrings.#25243

Merged
jklymak merged 1 commit intomatplotlib:mainfrom
anntzer:wxd
Feb 20, 2023
Merged

Cleanup wx docstrings.#25243
jklymak merged 1 commit intomatplotlib:mainfrom
anntzer:wxd

Conversation

@anntzer
Copy link
Copy Markdown
Contributor

@anntzer anntzer commented Feb 17, 2023

  • The "origin" keyword (for wx) has been deprecated in 591f92a and since then removed.
  • The canvas classes docstrings are inherited, but we don't even bother marking them as being inherited for other backends.

PR Summary

PR Checklist

Documentation and Tests

  • Has pytest style unit tests (and pytest passes)
  • Documentation is sphinx and numpydoc compliant (the docs should build without error).
  • New plotting related features are documented with examples.

Release Notes

  • New features are marked with a .. versionadded:: directive in the docstring and documented in doc/users/next_whats_new/
  • API changes are marked with a .. versionchanged:: directive in the docstring and documented in doc/api/next_api_changes/
  • Release notes conform with instructions in next_whats_new/README.rst or next_api_changes/README.rst

- The "origin" keyword (for wx) has been deprecated in 591f92a and since
  then removed.
- The canvas classes docstrings are inherited, but we don't even bother
  marking them as being inherited for other backends.
@timhoffm
Copy link
Copy Markdown
Member

The canvas classes docstrings are inherited, but we don't even bother marking them as being inherited for other backends.

I think this is an oversight and we should document all places where we intentionally don't have an explicit docstring.

@anntzer
Copy link
Copy Markdown
Contributor Author

anntzer commented Feb 18, 2023

That's ok too, but let's track that on a separate issue?

@jklymak jklymak merged commit b8a01ce into matplotlib:main Feb 20, 2023
@anntzer anntzer deleted the wxd branch February 20, 2023 22:21
@QuLogic QuLogic added this to the v3.8.0 milestone Feb 21, 2023
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.

4 participants