Document type hints individually #2282
Merged
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
szabosteve
approved these changes
Aug 29, 2023
|
Hey @pquentin This is a good improvement! Can we elide the optional arguments in the method signature? If you look at the Elasticsearch client constructor, it's still a really long list of arguments. Same with |
|
@joshdevins I looked at available Sphinx autodoc parameters but did not find anything that would allow us to do that: https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html, sorry. |
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 bulk() method used to be documented with an unreadable list of types in the signature:
Now types are listed for each parameter specifically:
Which is much easier to read.