Skip to content

Add valid values to get_*axis_transform docstring - #24443

Merged
dstansby merged 1 commit into
matplotlib:mainfrom
dstansby:xaxis-trans-param-doc
Nov 13, 2022
Merged

Add valid values to get_*axis_transform docstring#24443
dstansby merged 1 commit into
matplotlib:mainfrom
dstansby:xaxis-trans-param-doc

Conversation

@dstansby

Copy link
Copy Markdown
Member

PR Summary

Adds a listing of the valid values of which to get_xaxis_transform and get_yaxis_transform docstrings.

PR Checklist

Tests and Styling

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

Documentation

  • 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

@anntzer

anntzer commented Nov 13, 2022

Copy link
Copy Markdown
Contributor

can selfmerge once doc CI passes.

@dstansby
dstansby merged commit 686aab6 into matplotlib:main Nov 13, 2022
@dstansby
dstansby deleted the xaxis-trans-param-doc branch November 13, 2022 11:15
@QuLogic QuLogic added this to the v3.7.0 milestone Nov 15, 2022
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