Add support for short signatures in autosummary #13172
Open
Conversation
This file contains 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
get_items() already formats the signature. Handling :nosignatures: option in the saves the signature computation cost if the signature is not wanted. Also, this prepares for more complex signature options.
This is in preparation of extending singature formating.
timhoffm
force-pushed
the
autosummary-short-signature
branch
from
b87c5bc to
cd95331
Compare
This formats functions and classes with (…) if they have arguments and () if they don't have arguments. This makes it easier to distinguish callables from attributes and properties.
timhoffm
force-pushed
the
autosummary-short-signature
branch
from
cd95331 to
df273d6
Compare
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.
This introduces a new
:signatures:option to.. autosummary::.Possible values are:
func()if they do not have arguments andfunc(…)if they do have arguments.The new functionality here is the "short" option. This allows to distinguish properties and attributes from functions and classes without costing a lot of space for a long signature.
Note1: Design: I've added the
:signatures:option to have a single config value instead of:shortsignatures:alongside:nosignatures:. This is also more extensible in case other signature variants come up in the future.:nosignatures:remains available for backward compatibility, but:signatures:takes precedence if given.Note 2: Tests: There are currently no tests for the signature formatting. I could add some tests for
Autosummary.get_items, but I don't understand how to set up everything in a test so that I can exercise that function. Please give a hint how to do this if tests are desired.Closes #13101.