Fix most instances of D404 ("docstring should not start with 'this'"). #17148
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
timhoffm
reviewed
Apr 15, 2020
lib/matplotlib/axes/_base.py
Outdated
| This method can only be used after an initial draw which | ||
| caches the renderer. It is used to efficiently update Axes | ||
| data (axis ticks, labels, etc are not updated). | ||
| It is used to efficiently redraw Axes data (axis ticks, labels, etc., |
There was a problem hiding this comment.
Suggested change
| It is used to efficiently redraw Axes data (axis ticks, labels, etc., | |
| Efficiently redraw Axes data (axis ticks, labels, etc., |
| @@ -1026,9 +1026,9 @@ def Destroy(self, *args, **kwargs): | |||
|
|
|||
| class FigureManagerWx(FigureManagerBase): | |||
| """ | |||
| This class contains the FigureCanvas and GUI frame | |||
| A class contains the FigureCanvas and GUI frame. | |||
There was a problem hiding this comment.
Suggested change
| A class contains the FigureCanvas and GUI frame. | |
| Container/controller for the FigureCanvas and the GUI frame. |
lib/matplotlib/quiver.py
Outdated
| This function actually creates the wind barbs. *u* and *v* | ||
| are components of the vector in the *x* and *y* directions, | ||
| respectively. | ||
| Actually creates the wind barbs. |
There was a problem hiding this comment.
Suggested change
| Actually creates the wind barbs. | |
| Create wind barbs. |
lib/matplotlib/tight_bbox.py
Outdated
| @@ -1,5 +1,5 @@ | |||
| """ | |||
| This module is to support the *bbox_inches* parameter in `.Figure.savefig`. | |||
| Support module for the *bbox_inches* parameter in `.Figure.savefig`. | |||
There was a problem hiding this comment.
Suggested change
| Support module for the *bbox_inches* parameter in `.Figure.savefig`. | |
| Helper module for the *bbox_inches* parameter in `.Figure.savefig`. |
I have the impression that "helper module" is more common than "support module", but not sure.
lib/matplotlib/transforms.py
Outdated
Comment on lines
214
to
215
| The base class of all bounding boxes, which provides read-only access | ||
| to its data. A mutable bounding box is provided by the `Bbox` class. |
There was a problem hiding this comment.
Suggested change
| The base class of all bounding boxes, which provides read-only access | |
| to its data. A mutable bounding box is provided by the `Bbox` class. | |
| The base class of all bounding boxes. | |
| This box is immutable. See `Bbox` for a mutable bounding box. |
... and associated rewordings.
|
thanks, all handled. |
timhoffm
approved these changes
Apr 15, 2020
6 tasks
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.
... and associated rewordings.
(xref #17145 (comment)).
PR Summary
PR Checklist