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

Jump to bottom
Closed
wants to merge 1 commit into from
Closed

DOC: Show _CollectionWithSizes in the docs #28914

wants to merge 1 commit into from

Conversation

timhoffm
Copy link
Member

@timhoffm timhoffm commented Oct 1, 2024

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 _CollectionWithSizes. This also fixes the problem that set_sizes couldn't be referenced because it did not show up in the documentation.

@github-actions github-actions bot added the Documentation: API files in lib/ and doc/api label Oct 1, 2024
@timhoffm
DOC: set_sizes and get_sizes
7a92b3f 
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.
@timhoffm timhoffm marked this pull request as draft October 1, 2024 09:20
@timhoffm
Copy link
Member Author

timhoffm commented Oct 1, 2024

Still have to figure out the best way to cope with this. One of

  • Add the private class to the documentation
  • Try adding only the public methods of the private class to the children.

@timhoffm
Copy link
Member Author

timhoffm commented Oct 1, 2024

The original motivation for this was that a missing_reference entry was not matched anymore due to a line number change (#28702 (comment)). A proper solution is more complex and needs further investigation and decision making how to handle private base classes and how sphinx docs can cope with these. This is beyond what I want to do now. The quick-fix is to adapt the line numbers in missing_reference.json.

@timhoffm timhoffm closed this Oct 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
Documentation: API files in lib/ and doc/api GUI: webagg
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@timhoffm