Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 4 commits into from
Aug 2, 2023

Conversation

AntoineD
Copy link
Contributor

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

Copy link
Member

@pawamoy pawamoy left a comment

Choose a reason for hiding this comment

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

Thanks @AntoineD!

@pawamoy
Copy link
Member

pawamoy commented Jul 24, 2023

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
Contributor Author

It's fine, thank you.

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

@pawamoy
Copy link
Member

pawamoy commented Jul 24, 2023

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

@AntoineD
Copy link
Contributor Author

Is there anything left to do?

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

pawamoy commented Aug 2, 2023

Thanks again @AntoineD!

pawamoy pushed a commit that referenced this pull request Aug 6, 2023
PR #92: #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