Essential docstring coverage #115
Merged
Conversation
This file contains 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
- Need `Table` and `TableSpecs` attributes - Consider inheritance for base table specs (and dropping protocol)
- I believe this fixes my attrs dataclass woes
- "Parameters" section only shows up in classes if it's provided directly in docstring
- If it's undocumented, it doesn't belong in the docs - If there are a mix of public/private members in a module, the current configuration respects __all__.
- delegate to docs
- Still need to properly cross-reference the API
61 tasks
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.
A major milestone worthy of a release soon to follow.
We now have docs available at https://pooltool.readthedocs.io/, and they provide the most essential coverage.