Cleanup GridHelperCurveLinear/GridFinder. #25729
Merged
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
oscargus
reviewed
Apr 20, 2023
| Internal helper for `.GridHelperCurveLinear`, with the same constructor parameters; | ||
| should not be directly instantiated. | ||
| """ | ||
|
|
||
| def __init__(self, | ||
| transform, |
There was a problem hiding this comment.
Modify this to aux_trans for consistency (as this is the internal one, probably makes more sense to modify it here)?
There was a problem hiding this comment.
I don't really want to bother going through a separate deprecation of the parameter name if we're going to fully inline GridFinder anyways. Plus, aux_trans is a pretty awkward name, if anything I actually prefer transform.
oscargus
reviewed
Apr 20, 2023
Comment on lines
+248
to
+254
| extreme_finder | ||
|
|
||
| grid_locator1, grid_locator2 | ||
| Grid locators for each axis. | ||
|
|
||
| tick_formatter1, tick_formatter2 | ||
| Tick formatters for each axis. |
There was a problem hiding this comment.
Suggested change
| extreme_finder | |
| grid_locator1, grid_locator2 | |
| Grid locators for each axis. | |
| tick_formatter1, tick_formatter2 | |
| Tick formatters for each axis. | |
| extreme_finder : optional | |
| grid_locator1, grid_locator2 : Locator, optional | |
| Grid locators for each axis. | |
| tick_formatter1, tick_formatter2 : Formatter, optional | |
| Tick formatters for each axis. |
Not sure which class extreme_finder is. Bonus for proper links...
There was a problem hiding this comment.
They're not really locators and formatters though (but rather axisartist's variants on them).
oscargus
approved these changes
Apr 20, 2023
- GridHelperCurveLinear: numpydocify; remove unused _aux_trans attribute. - GridFinder: This class is used nowhere else but as attribute on GridHelperCurveLinear and could probably be inlined into it; for now, remove the duplicated constructor docstring.
QuLogic
approved these changes
Apr 21, 2023
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.
PR Summary
PR Checklist
Documentation and Tests
pytestpasses)Release Notes
.. versionadded::directive in the docstring and documented indoc/users/next_whats_new/.. versionchanged::directive in the docstring and documented indoc/api/next_api_changes/next_whats_new/README.rstornext_api_changes/README.rst