DOC: set_sizes and get_sizes

timhoffm · timhoffm · commit 97f5efea7617 · 2024-10-01T10:43:23.000+02:00
From a documentation perspective, it's not quite ideal to have a private
base class. Maybe we have to rearchitect at some point.
But for now, just document the two public methods of `_CollectionWithSizes`
in the child classes.
diff --git a/doc/api/collections_api.rst b/doc/api/collections_api.rst
@@ -11,3 +11,9 @@
    :undoc-members:
    :show-inheritance:
    :inherited-members:
+   :private-members: set_sizes, get_sizes
+
+.. set_sizes and get_sizes are defined in the private base class
+   _CollectionWithSizes. These are public for child classes and
+   thus should be listed there.
+
