Skip to content

Clarify secondary_axis documentation #22474

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
Feb 16, 2022
Merged

Conversation

ClementPhan
Copy link

The documentation dos not specify that the functions used to set the secondary axis must be able to accept numpy arrays as inputs. The relevant docstring has been edited for better clarity.

Resolves #22473

PR Summary

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).
  • [N/A] 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).

The functions used for the transformation to and from the secondary axis
must accept numpy arrays, which was not explicit in the
documentation.
Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Thank you for opening your first PR into Matplotlib!

If you have not heard from us in a while, please feel free to ping @matplotlib/developers or anyone who has commented on the PR. Most of our reviewers are volunteers and sometimes things fall through the cracks.

You can also join us on gitter for real-time discussion.

For details on testing, writing docs, and our review process, please see the developer guide

We strive to be a welcoming and open project. Please follow our Code of Conduct.

@timhoffm timhoffm added this to the v3.5.2 milestone Feb 16, 2022
@timhoffm
Copy link
Member

Thanks and congratulations on your first contribution to Matplotlib! We hope to see you back.

QuLogic added a commit that referenced this pull request Feb 16, 2022
…474-on-v3.5.x

Backport PR #22474 on branch v3.5.x (Clarify secondary_axis documentation)
@ClementPhan ClementPhan deleted the secax_doc branch February 16, 2022 07:40
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.

[Bug]: Secondary axis does not accept python builtins for transform
2 participants