Closed
Conversation
terencehonles
commented
Nov 15, 2021
| pygments_style = "sphinx" | ||
| autodoc_typehints = "description" | ||
| autoclass_content = "both" | ||
| autodoc_typehints = "both" |
Contributor
Author
There was a problem hiding this comment.
Just calling out so it doesn't get burried in the PR description, this requires Sphinx 4.1 and probably shouldn't be changed on older versions.
Owner
|
This change does not appear to be necessary. I prefer to put type hints in the description, not signature, to keep the signature more readable. And with the current configuration, sphinx already renders the type hints in the parameter description correctly (see https://kislyuk.github.io/watchtower/#watchtower.CloudWatchLogHandler). |
This file contains hidden or 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
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.
Pulling changes out of #144
Fixes this:
To this:
If you're using Sphinx > 4.1 you can use
autodoc_typehintsasbothinstead ofdescriptionas I had initially put in #144 and you put in ed0d3cc, if not you should leavedescriptionsincebothis 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: