feat: add default values, if any, when showing parameters as a list#92
Merged
pawamoy merged 4 commits intomkdocstrings:mainfrom Aug 2, 2023
Merged
Conversation
pawamoy
requested changes
Jul 23, 2023
src/mkdocstrings_handlers/python/templates/material/_base/docstring/parameters.html
Outdated
Show resolved
Hide resolved
Member
|
I've moved the display of the default value next to the type, because showing it after the description was adding a new block (in HTML terms), and it's quite hard to force things to be shown in-line correctly. Let me know what you think. |
Contributor
Author
|
It's fine, thank you. I just noticed the suffixed |
Member
|
Yes, if we use |
Contributor
Author
|
Is there anything left to do? |
pawamoy
approved these changes
Aug 2, 2023
Member
|
Thanks again @AntoineD! |
viktorlashchuk
added a commit
to viktorlashchuk/mkdocstrings-python
that referenced
this pull request
Feb 24, 2025
PR #92: mkdocstrings/python#92 Co-authored-by: Timothée Mazzucotelli <pawamoy@pm.me>
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.
The defaults are shown for table and spacy but not for list.