Skip to content

DOC: Show _CollectionWithSizes in the docs #28914

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

DOC: Show _CollectionWithSizes in the docs #28914

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions doc/api/collections_api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Check warning on line 19 in doc/api/collections_api.rst

View workflow job for this annotation

GitHub Actions / sphinx

[sphinx] doc/api/collections_api.rst#L19 

py:class reference target not found: matplotlib.collections._CollectionWithSizes [ref.class]
Raw output 
doc/api/collections_api.rst:19: WARNING: py:class reference target not found: matplotlib.collections._CollectionWithSizes [ref.class]

Check warning on line 19 in doc/api/collections_api.rst

View workflow job for this annotation

GitHub Actions / sphinx

[sphinx] doc/api/collections_api.rst#L19 

py:class reference target not found: matplotlib.collections._MeshData [ref.class]
Raw output 
doc/api/collections_api.rst:19: WARNING: py:class reference target not found: matplotlib.collections._MeshData [ref.class]
Loading
Loading