DOC: Add docstrings to matplotlib.cbook.GrouperView #29617
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
|
LGTM, but please fix the linting errors. |
|
The linting problem is that the original code was also not conforming (not sure why this is not flagged). It should be sufficient to introduce empty lines before the modified methods. |
timhoffm
reviewed
Feb 14, 2025
lib/matplotlib/cbook.py
Outdated
Comment on lines
853
to
855
| """ | ||
| Return whether *a* and *b* are members of the same set. | ||
| """ |
There was a problem hiding this comment.
This change is not necessary, in fact the original one conforms to our style https://matplotlib.org/devdocs/devel/document.html#quote-positions. Please revert.
lib/matplotlib/cbook.py
Outdated
Comment on lines
859
to
861
| """ | ||
| Remove *a* from the grouper, doing nothing if it is not there. | ||
| """ |
Co-authored-by: Tim Hoffmann <2836374+timhoffm@users.noreply.github.com>
Co-authored-by: Tim Hoffmann <2836374+timhoffm@users.noreply.github.com>
timhoffm
approved these changes
Feb 14, 2025
meeseeksmachine
pushed a commit
to meeseeksmachine/matplotlib
that referenced
this pull request
Feb 14, 2025
|
Thanks @star1327p and congratulations on your first contribution to Matplotlib! 🎉 |
timhoffm
pushed a commit
that referenced
this pull request
Feb 15, 2025
…ew (#29627) Co-authored-by: Christine P. Chai <star1327p@gmail.com>
prafulgulani
pushed a commit
to prafulgulani/matplotlib
that referenced
this pull request
Feb 22, 2025
* DOC: Add docstrings to matplotlib.cbook.GrouperView * DOC: Fixed linting errors in cbook.py * Update cbook.py Co-authored-by: Tim Hoffmann <2836374+timhoffm@users.noreply.github.com> * Update cbook.py Co-authored-by: Tim Hoffmann <2836374+timhoffm@users.noreply.github.com> * Revert unnecessary changes * Removed unnecessary whitespace --------- Co-authored-by: Tim Hoffmann <2836374+timhoffm@users.noreply.github.com>
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
Add docstrings to matplotlib.cbook.GrouperView
PR checklist