Repository navigation
DOC incorporate type annotations in docs - #1689
Open
Badagala Bharath Kumar (Bharath-kumar-7) wants to merge 1 commit into
Open
Badagala Bharath Kumar (Bharath-kumar-7) wants to merge 1 commit into
Badagala Bharath Kumar (Bharath-kumar-7) wants to merge 1 commit into
Conversation
Coverage Report for CI Build 37588752843Coverage remained the same at 94.692%Details
Uncovered ChangesNo uncovered changes found. Coverage RegressionsNo coverage regressions found. Coverage Stats
💛 - Coveralls |
This branch has not been deployed
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.
Summary
This PR addresses #1428 by incorporating the existing type annotations into the generated documentation and restoring signatures for
singledispatchmethods.Changes
autodoc_typehintsto"signature"so type annotations are included in API signatures.avoid_duplicate_in_dispatchworkaround that was introduced in Temporarily disable typehints and singledispatch in function signatures #606..pyistubs.Testing
python -m py_compile docs/source/conf.pygit diff --checkCloses #1428