Clean up docs #142
Merged
Clean up docs #142
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
This commit fixes all warnings in the docs, except for the warning that the modules' docstrings are not included in the documentation. The warning for Base.close() is no longer thrown, but the correct docstrings are not shown in the correct places. This cannot be fixed unless the necessary types are exported from the relevant modules.
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 commit fixes all warnings in the docs,
except for the warning that the modules' docstrings are not included in the documentation.
The warning for Base.close() is no longer thrown,
but the correct docstrings are not shown in the correct places. This cannot be fixed unless the necessary types are exported from the relevant modules.
Closes #141
Purpose
To-do
Content