-
-
Notifications
You must be signed in to change notification settings - Fork 7.9k
Modified docstring of the set_ylabel and set_xlabel #13546
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
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.
Thanks - I think the new lines are too long however (must be < 79 characters to pass flake8)
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.
👍 thanks for submitting the change. We try and adhere to the PEP8 style guides, which means the lines can't be too long - I've left a message expanding this on the diff. Otherwise looks good!
lib/matplotlib/axes/_axes.py
Outdated
@@ -206,7 +206,7 @@ def set_xlabel(self, xlabel, fontdict=None, labelpad=None, **kwargs): | |||
The label text. | |||
|
|||
labelpad : scalar, optional, default: None | |||
Spacing in points between the label and the x-axis. | |||
Spacing in points from the axes bounding box including ticks and tick labels. |
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.
Could you make the lines <= 79 characters long by running the sentence on to the next line?
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.
@dstansby please check the latest commit (4). I have addressed the issue. Thank you!
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.
Thanks a lot!
…546-on-v3.1.x Backport PR #13546 on branch v3.1.x ( Modified docstring of the set_ylabel and set_xlabel)
PR Summary
Closes #13487
labelpad
is a distance in points from the axes bounding box including ticks and tick labels. However presently documentation ofmatplotlib.axes.Axes.set_ylabel
reads -"labelpad : Spacing in points between the label and the y-axis."
PR Checklist