Ensures that @qfunc_transform
decorated functions display their signatures in the docs
#2286
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.
Context: Decorated functions do not correctly display their signatures in the docs
Description of the Change: If a Sphinx build is detected, the
@qfunc_transform
decorator will simply return the function unchanged, allowing Sphinx to correctly introspect the signature.Benefits: As above.
Possible Drawbacks: None
Related GitHub Issues: Fixes #2283