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

Skip to content

Cleanup category.py docstrings. #16072

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
Jan 2, 2020
Merged

Cleanup category.py docstrings. #16072

merged 1 commit into from
Jan 2, 2020

Conversation

anntzer
Copy link
Contributor

@anntzer anntzer commented Jan 2, 2020

PR Summary

For the better or (mostly) the worst, we support both bytes and str.
AnyStr is the union of both of them (per stdlib typing).

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

@jklymak
Copy link
Member

jklymak commented Jan 2, 2020

AnyStr seems pretty obscure though. Unless there is some reason to steer people to byte strings is there any reason to be precise about the docstring?

@anntzer
Copy link
Contributor Author

anntzer commented Jan 2, 2020

I'm fine either way. (Or we can go for Union[str, bytes] too.)

For the better or (mostly) the worst, we support both bytes and str.
AnyStr is the union of both of them (per stdlib typing).
@anntzer
Copy link
Contributor Author

anntzer commented Jan 2, 2020

went with @timhoffm's suggestion

@timhoffm
Copy link
Member

timhoffm commented Jan 2, 2020

Waiting to see if there are objections. Otherwise can self-merge after a day or so.

@jklymak jklymak merged commit b575820 into matplotlib:master Jan 2, 2020
@anntzer anntzer deleted the catdoc branch January 2, 2020 18:57
@QuLogic QuLogic added this to the v3.3.0 milestone Jan 3, 2020
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.

5 participants