fix(docs): preserve inherited method types and overloads - #1241
Open
sylvesterkaczmarek wants to merge 1 commit into
Open
sylvesterkaczmarek wants to merge 1 commit into
sylvesterkaczmarek wants to merge 1 commit into
Conversation
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
1 participant
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.
Fixes #795.
Complete the type documentation for unannotated method overrides from compatible base methods. Preserve explicit subclass annotations and overloads, follow the method resolution order, and leave changed parameter lists alone. Runtime methods and numerical code are unchanged.
The current type-hint extension already renders directly declared overloads. This adds the missing inherited annotations and overloads for concrete kernels through a documentation-only hook.
Validation: 10 Sphinx regression tests passed, including real kernel methods and inheritance edge cases. Five fail without the new hook. The full HTML documentation build passed with
-E -n -W; applicable pre-commit checks passed. Tested in the locked Python 3.12 environment.The numerical unit suite was not rerun because no numerical code changed.