Skip to content

Commit 7a92b3f

Browse files
committed
DOC: set_sizes and get_sizes
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.
1 parent 14dda09 commit 7a92b3f

File tree

2 files changed

+60
-54
lines changed

2 files changed

+60
-54
lines changed

doc/api/collections_api.rst

+6
Original file line numberDiff line numberDiff line change
@@ -11,3 +11,9 @@
1111
:undoc-members:
1212
:show-inheritance:
1313
:inherited-members:
14+
:private-members: set_sizes, get_sizes
15+
16+
.. set_sizes and get_sizes are defined in the private base class
17+
_CollectionWithSizes. These are public for child classes and
18+
thus should be listed there.
19+

0 commit comments

Comments
 (0)