Skip to content

feat: add default values, if any, when showing parameters as a list - #92

Merged
pawamoy merged 4 commits into
mkdocstrings:mainfrom
AntoineD:add-defaults-to-parameters-list
Aug 2, 2023
Merged

feat: add default values, if any, when showing parameters as a list#92
pawamoy merged 4 commits into
mkdocstrings:mainfrom
AntoineD:add-defaults-to-parameters-list

Conversation

@AntoineD

Copy link
Copy Markdown
Contributor

The defaults are shown for table and spacy but not for list.

@pawamoy pawamoy left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @AntoineD!

@pawamoy

pawamoy commented Jul 24, 2023

Copy link
Copy Markdown
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.

@AntoineD

Copy link
Copy Markdown
Contributor Author

It's fine, thank you.

I just noticed the suffixed : in the language macros, is it intended?

@pawamoy

pawamoy commented Jul 24, 2023

Copy link
Copy Markdown
Member

Yes, if we use lang.t("default:"), then the colon must appear in the language file too.

@AntoineD

Copy link
Copy Markdown
Contributor Author

Is there anything left to do?

@pawamoy
pawamoy merged commit 5b852ce into mkdocstrings:main Aug 2, 2023
@pawamoy

pawamoy commented Aug 2, 2023

Copy link
Copy Markdown
Member

Thanks again @AntoineD!

pawamoy added a commit that referenced this pull request Aug 6, 2023
PR #92: #92
Co-authored-by: Timothée Mazzucotelli <pawamoy@pm.me>
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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants