Tweak docstrings to fix rendered docs #923
Merged
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.
In a similar vein to materialsproject/api#863, this PR makes several docstring fixes that are otherwise breaking the rendered mkdocs, making it quite hard for users to use the API without digging into the code.
Example from deployed docs:
Which will now look like:
There are still hundreds of pydocstyle warnings but I think this at least fixes the ones that mkdocs(trings) will care about.