Fixed default options not displaying for parameters without type hints. #279
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
for more information, see https://pre-commit.ci
…t typehints. Resolves tox-dev#234.
# Conflicts: # tests/test_sphinx_autodoc_typehints.py
…t typehints. Resolves tox-dev#234.
for more information, see https://pre-commit.ci
gaborbernat
approved these changes
Jan 5, 2023
|
Looks alright once the CI passes. |
|
Any ideas on how to fix this?
set_python_path()
app.config.master_doc = "without_complete_typehints" # type: ignore # create flag
app.config.typehints_defaults = "comma"
app.build()A similar syntax seems to work with the tests above this one... |
|
You must add trailing |
|
@gaborbernat does this look okay? |
gaborbernat
approved these changes
Jan 6, 2023
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.
Resolves #234
format_default()takes a new parameteris_annotatedto better format the option._inject_types_to_docstring()now iterates through all signature parameters. Unchanged behaviour for parameters with type hints, but parameters without type hints now get their default value shown.Also added tests with 4 functions trying out different variations with/without type hints, default values, and return types.
Works with both the "braces" and "commas" setting for
typehints_defaults.Before:
After:
