DOC: Add docstrings to matplotlib.cbook.GrouperView (matplotlib#29617)

star1327p · timhoffm · web-flow · commit f94fce68abe6 · 2025-02-15T00:12:02.000+01:00
* DOC: Add docstrings to matplotlib.cbook.GrouperView

* DOC: Fixed linting errors in cbook.py

* Update cbook.py

Co-authored-by: Tim Hoffmann &lt;2836374+timhoffm@users.noreply.github.com&gt;

* Update cbook.py

Co-authored-by: Tim Hoffmann &lt;2836374+timhoffm@users.noreply.github.com&gt;

* Revert unnecessary changes

* Removed unnecessary whitespace

---------

Co-authored-by: Tim Hoffmann &lt;2836374+timhoffm@users.noreply.github.com&gt;
diff --git a/lib/matplotlib/cbook.py b/lib/matplotlib/cbook.py
@@ -880,8 +880,18 @@ class GrouperView:
     def __init__(self, grouper): self._grouper = grouper
     def __contains__(self, item): return item in self._grouper
     def __iter__(self): return iter(self._grouper)
-    def joined(self, a, b): return self._grouper.joined(a, b)
-    def get_siblings(self, a): return self._grouper.get_siblings(a)
+
+    def joined(self, a, b):
+        """
+        Return whether *a* and *b* are members of the same set.
+        """
+        return self._grouper.joined(a, b)
+
+    def get_siblings(self, a):
+        """
+        Return all of the items joined with *a*, including itself.
+        """
+        return self._grouper.get_siblings(a)
 
 
 def simple_linear_interpolation(a, steps):
