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.
Pulling changes out of #144
Fixes this:
To this:
If you're using Sphinx > 4.1 you can use
autodoc_typehints
asboth
instead ofdescription
as I had initially put in #144 and you put in ed0d3cc, if not you should leavedescription
sinceboth
is not understood and will becomesignature
.The
autoclass_content = "both"
does not actually seem like it's needed either anymore or maybe at all, but it's something I've run into before and is confusing that that isn't the default behavior. It will concatenate any docstring in__init__
and in the class body in order to document the class. There doesn't seem to be any documentation in the__init__
so it's unneeded, but it doesn't hurt to have so you don't have potentially future documentation get ignored.See: