-
-
Notifications
You must be signed in to change notification settings - Fork 7.9k
Cleanup of docstrings of scales #14654
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
Conversation
@@ -100,8 +107,8 @@ def set_default_locators_and_formatters(self, axis): | |||
|
|||
def get_transform(self): | |||
""" | |||
The transform for linear scaling is just the | |||
:class:`~matplotlib.transforms.IdentityTransform`. | |||
Return the transform for linear scaling, which is just the |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
just inherit all these docstrings? not sure per-scale documentation of get_transform is really useful.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For now, I'd leave it. There's a bit of value to have the link to the respective transform in the subclasses. Alternatively, one could document these relations for the builtin scales in a common place. and eliminate most of the get_transform
s. Almost all are just returning self._transform
. But that's for another time. You are welcome to make a PR (after this is merged 😉).
a9875dc
to
b653f5f
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some typos to fix.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
one more nitpick, can self-merge after fix
Owee, I'm MrMeeseeks, Look at me. There seem to be a conflict, please backport manually. Here are approximate instructions:
And apply the correct labels and milestones. Congratulation you did some good work ! Hopefully your backport PR will be tested by the continuous integration and merged soon! If these instruction are inaccurate, feel free to suggest an improvement. |
Not bothering to backport as 3.2 is approaching. |
PR Summary