Shorten implementation of Axes methods that just wrap Axis methods. #16903
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
6 tasks
de876cc to
61c99b6
Compare
tacaswell
reviewed
Apr 4, 2020
6 tasks
61c99b6 to
98534b6
Compare
|
I pushed a slightly different implementation (directly lifting the "Placeholder" class out) and left some comments explaining why this relies on |
timhoffm
reviewed
Apr 5, 2020
| to the ``get_bar`` method of the ``xaxis`` attribute, and gets its | ||
| signature and docstring from ``Axis.get_bar``. | ||
|
|
||
| The docstring of ``get_foo`` is built by replacing "this Axis" by "the |
There was a problem hiding this comment.
I'm slightly worried that subsequent edits on the docstring will break this clever replacements. People usually won't know that "this Axis" has a special meaning. They could easily write:
this axisthis `.Axis`the axis
I'm afraid that we can't do much in terms of documenting this for docstring authors or warning upon processing. But let's at least include the first two variants for replacement.
There was a problem hiding this comment.
I'd rather keep things consistent. Note that there is an assertion check that the correct substring is present, with a hopefully clear error message -- and the check occurs at import time, so we'd easily catch it in CI.
There was a problem hiding this comment.
Ok, I did not realize the assert.
98534b6 to
aab2b3f
Compare
timhoffm
approved these changes
Apr 5, 2020
| to the ``get_bar`` method of the ``xaxis`` attribute, and gets its | ||
| signature and docstring from ``Axis.get_bar``. | ||
|
|
||
| The docstring of ``get_foo`` is built by replacing "this Axis" by "the |
There was a problem hiding this comment.
Ok, I did not realize the assert.
|
Lot's of warnings in the sphinx build I think they are unrelated, but not sure about it. Edit: Same warnings in #17021. Either we have commited something that breaks these or it's caused by sphinx 3.0.0, which has been released a couple of hours ago. |
|
I'd believe it's something to do with sphinx 3.0, but I'm fine waiting for that to be handled first (e.g. by temporarily pinning to <3.0) before merging this. Edit: rebased over the sphinx fix. |
... by autogenerating wrappers that forward to the Axis methods. Admittedly docstring search/replace is a bit ugly, but this has to be compared with having 4 copies of the docstrings for each method (Axis, xaxis, yaxis, zaxis) each to be kept in sync.
aab2b3f to
1f62d29
Compare
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.
... by autogenerating wrappers that forward to the Axis methods.
Admittedly docstring search/replace is a bit ugly, but this has to be
compared with having 4 copies of the docstrings for each method (Axis,
xaxis, yaxis, zaxis) each to be kept in sync.
(As an anecdote, the ability to do this templatization for mplot3d was what originally motivated me to check whether minor ticks could easily be fixed for 3d axes...)
PR Summary
PR Checklist