Very soft-deprecate AxesDivider.new_{horizontal,vertical}. #20117
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
|
Ah, of course, they don't show up in the docs now that I explicitly hid them :-) |
QuLogic
reviewed
May 13, 2021
| position : {"left", "right", "bottom", "top"} | ||
| Where the new axes is positioned relative to the main axes. | ||
| size : :mod:`~mpl_toolkits.axes_grid1.axes_size` or float or str | ||
| The axes width. float or str arguments are interpreted as |
`append_axes` is a more general API which is basically just as
ergonomic, and avoids exposing the slightly unusual feature of
axes_grid having indices increasing towards the top for vertical
stacks (contrary to gridspec which goes towards the bottom), and hence
`new_vertical(append_start={True,False})` behaving in the opposite
direction as one may naively expect.
Given that `new_horizontal` and `new_vertical` would basically stay as
helpers, it seems overkill to deprecate them, but perhaps we can at
least hide them from the docs (`:meta private:`). Also promote
`axes_class` to be a plain normal parameter.
QuLogic
approved these changes
Oct 21, 2021
jklymak
approved these changes
Jan 5, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
append_axesis a more general API which is basically just asergonomic, and avoids exposing the slightly unusual feature of
axes_grid having indices increasing towards the top for vertical
stacks (contrary to gridspec which goes towards the bottom), and hence
new_vertical(append_start={True,False})behaving in the oppositedirection as one may naively expect.
Given that
new_horizontalandnew_verticalwould basically stay ashelpers, it seems overkill to deprecate them, but perhaps we can at
least hide them from the docs (
:meta private:). Also promoteaxes_classto be a plain normal parameter.PR Summary
PR Checklist
pytestpasses).flake8on changed files to check).flake8-docstringsand runflake8 --docstring-convention=all).doc/users/next_whats_new/(follow instructions in README.rst there).doc/api/next_api_changes/(follow instructions in README.rst there).