Full function signature in rST (functions & methods)#20
Open
n-peugnet wants to merge 1 commit intoavalanche123:masterfrom
Open
Full function signature in rST (functions & methods)#20n-peugnet wants to merge 1 commit intoavalanche123:masterfrom
n-peugnet wants to merge 1 commit intoavalanche123:masterfrom
Conversation
The only part we need to strip from the signature is the 'function' one, sphinxcontrib-phpdomains handles pretty well the rest of the signature. This adds a lot more details to the docs, by showing where the parameters are, their default values and the optional return value Type hint. This also allows to visually differentiate instance methods from class methods.
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.
The only part we need to strip from the signature is the 'function' one, sphinxcontrib-phpdomains handles pretty well the rest of the signature.
This adds a lot more details to the docs, by showing where the parameters are, their default values and the optional return value Type hint.
This also allows to visually differentiate instance methods from class
methods.
Example
Before:
After: