DOC Improve parameter type display#87
Merged
BorisMuzellec merged 14 commits intomainfrom Feb 23, 2023
Merged
Conversation
added 10 commits
February 22, 2023 15:18
…to retrieve them automatically
BorisMuzellec
changed the title
BorisMuzellec
requested review from
arthurPignetOwkin and
maikia
as code owners
maikia
approved these changes
Feb 23, 2023
Collaborator
maikia
left a comment
maikia
left a comment
There was a problem hiding this comment.
LGTM, thanks @BorisMuzellec
docs/source/conf.py
Outdated
| autosummary_generate = False | ||
| autodoc_member_order = "groupwise" | ||
| autodoc_docstring_signature = True | ||
| python_use_unqualified_type_names = True |
Collaborator
There was a problem hiding this comment.
just a suggestion: we didn't write a comment on any of those sphinx settings and it's starting to be a lot of them, not always clear on a why. What do you think of adding a short comment on a why it is here?
Collaborator
Author
There was a problem hiding this comment.
Good idea, I'll add comments to explain their roles
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
2 participants
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.
Reference Issue or PRs
Fixes #86
What does your PR implement? Be specific.
This PR improves the display of parameters and returns types in the documentation.
Before:
After:
