Fix warnings in the documentation build #360
Draft
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
Merged
|
@ssolson this should be a low lift to review when ready. We don't need to delay our release for this PR, but it would be great to merge whatever is pushed here and ready before the release. This will help ease future documentation updates and keep it fully updated. |
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 PR pairs with MHKiT-Software/MHKiT#80 and aims to eliminate the volume of warnings occurring in our documentation build.
Many of these changes will probably be fixing minor spacings/lines/issues in docstrings that show up as warnings but not errors when the documentation builds. Future linting should address and prevent these issues too.