DOC: Document _CollectionWithSizes #29561
Merged
Conversation
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
d268cc8 to
6349fa0
Compare
This is needed to get `_CollectionWithSizes.set_sizes` documented so that it can be referenced. Alternative approach to matplotlib#29560.
6349fa0 to
7ef49f0
Compare
|
Sphinx configuration was a bit tricky. I had to override some defaults from Anyway, I believe it's reasonable to have minimal documentation on the private base classes. The aspects that leak out in the child classes should be documented. We cannot completely hide a private base class. |
story645
approved these changes
Feb 4, 2025
|
I like this approach, seems very clean and intentional. |
9 tasks
timhoffm
added a commit
to timhoffm/matplotlib
that referenced
this pull request
Feb 5, 2025
timhoffm
added a commit
to timhoffm/matplotlib
that referenced
this pull request
Feb 5, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is needed to get
_CollectionWithSizes.set_sizesdocumented so that it can be referenced.Alternative approach to #29560.