FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

DOC: Add docstrings to matplotlib.cbook.GrouperView by star1327p · Pull Request #29617 · matplotlib/matplotlib · GitHub

  1. matplotlib
  2. matplotlib

Repository navigation

DOC: Add docstrings to matplotlib.cbook.GrouperView - #29617

Merged
timhoffm merged 7 commits into
matplotlib:mainfrom
star1327p:add-docstring-cbook-api
Feb 14, 2025
ConversationCommits (7)ChecksFiles changed
Merged

DOC: Add docstrings to matplotlib.cbook.GrouperView#29617
timhoffm merged 7 commits into
matplotlib:mainfrom
star1327p:add-docstring-cbook-api

Conversation

star1327p commented Feb 14, 2025

Copy link
Copy Markdown
Contributor

PR summary

Add docstrings to matplotlib.cbook.GrouperView

PR checklist

QuLogic commented Feb 14, 2025

Copy link
Copy Markdown
Member

LGTM, but please fix the linting errors.

timhoffm commented Feb 14, 2025

Copy link
Copy Markdown
Member

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.

star1327p commented Feb 14, 2025

Copy link
Copy Markdown
Contributor Author

@QuLogic @timhoffm Thank you both for the comments! I have revised the linting parts, and hope this works!

timhoffm reviewed Feb 14, 2025
View reviewed changes

timhoffm left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Sorry if our comments have not been clear.

Comment thread lib/matplotlib/cbook.py Outdated
Comment on lines +853 to +855
"""
Return whether *a* and *b* are members of the same set.
"""

timhoffm Feb 14, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

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.

star1327p Feb 14, 2025

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

@timhoffm I manually changed it back in comment 08982e9

Comment thread lib/matplotlib/cbook.py Outdated
Comment on lines +859 to +861
"""
Remove *a* from the grouper, doing nothing if it is not there.
"""

timhoffm Feb 14, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

As above.

star1327p Feb 14, 2025

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

@timhoffm I manually changed it back in comment 08982e9

Comment thread lib/matplotlib/cbook.py
Comment thread lib/matplotlib/cbook.py
star1327p and others added 4 commits February 14, 2025 11:50
Update cbook.py
c951f1a 
Co-authored-by: Tim Hoffmann <2836374+timhoffm@users.noreply.github.com>
Update cbook.py
8d2b682 
Co-authored-by: Tim Hoffmann <2836374+timhoffm@users.noreply.github.com>
Revert unnecessary changes
08982e9
Removed unnecessary whitespace
eb7cae3
timhoffm added this to the v3.10.1 milestone Feb 14, 2025
timhoffm merged commit f94fce6 into matplotlib:main Feb 14, 2025
meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request Feb 14, 2025
Backport PR matplotlib#29617: DOC: Add docstrings to matplotlib.cbook…
72e8978 
….GrouperView
meeseeksmachine mentioned this pull request Feb 14, 2025
Merged

timhoffm commented Feb 15, 2025

Copy link
Copy Markdown
Member

Thanks @star1327p and congratulations on your first contribution to Matplotlib! 🎉

timhoffm pushed a commit that referenced this pull request Feb 15, 2025
Backport PR #29617: DOC: Add docstrings to matplotlib.cbook.GrouperVi…
c3dc3a2 
…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 (matplotlib#29617)
50fbe7f 
* 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>
ksunden mentioned this pull request Mar 3, 2025
Merged
5 tasks
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
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

timhoffm timhoffm approved these changes

Assignees

No one assigned

Labels

Documentation

Projects

None yet

Milestone

v3.10.1

Development

Successfully merging this pull request may close these issues.

3 participants

Back | FazBrowse Home | New Git URL