Skip to content

update FAQ on how to register pandas converters #16906

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 27, 2020

Conversation

terencehonles
Copy link
Contributor

PR Summary

pandas.tseries.converter no longer exists, and the individual converters are not part of the public API so this change updates the documentation to reflect how to properly register the pandas converters with matplotlib.

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

Copy link
Member

@story645 story645 left a comment

Choose a reason for hiding this comment

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

Thanks for the PR & it's fine as is. This is my suggestion but I didn't want to overstep by directly committing the changes:

If you prefer the pandas converters and locators, you can register them.
This is done automatically when calling a pandas plot function and may be unnecessary
when using pandas instead of matplotlib directly. ::

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.

I agree with @story645 that the parentheses could be dropped.

`pandas.tseries.converter` no longer exists, and the individual converters are
not part of the public API so this change updates the documentation to reflect
how to properly register the pandas converters with matplotlib.
@terencehonles
Copy link
Contributor Author

Done

@QuLogic QuLogic added this to the 3.2-doc milestone Mar 26, 2020
@QuLogic QuLogic merged commit 5e74fb4 into matplotlib:master Mar 27, 2020
meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request Mar 27, 2020
QuLogic added a commit that referenced this pull request Mar 27, 2020
…906-on-v3.2.1-doc

Backport PR #16906 on branch v3.2.1-doc (update FAQ on how to register pandas converters)
@terencehonles terencehonles deleted the update-faq branch April 9, 2020 04:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants