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

fix(docs): render func args as args, not list of args #10559

Merged
merged 1 commit into from
Dec 6, 2024

Conversation

gforsyth
Copy link
Member

@gforsyth gforsyth commented Dec 6, 2024

Description of changes

Fixes the way we render docstrings in the docs so that we show the argument
names, and keyword defaults, as they should be entered, and not as a list of
strings.

Issues closed

Fixes #10558

@gforsyth gforsyth force-pushed the fix_docstring_rendering branch from f4fa4d3 to e4af770 Compare December 6, 2024 01:07
@gforsyth gforsyth added the docs-preview Add this label to trigger a docs preview label Dec 6, 2024
@ibis-docs-bot ibis-docs-bot bot removed the docs-preview Add this label to trigger a docs preview label Dec 6, 2024
@ibis-docs-bot
Copy link

ibis-docs-bot bot commented Dec 6, 2024

@IndexSeek IndexSeek self-requested a review December 6, 2024 03:55
Copy link
Member

@IndexSeek IndexSeek left a comment

Choose a reason for hiding this comment

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

Nice! Thank you for tackling this one.

I also remember seeing the report on Zulip.

@IndexSeek IndexSeek enabled auto-merge (squash) December 6, 2024 04:03
@cpcloud cpcloud merged commit 51d90a7 into ibis-project:main Dec 6, 2024
22 checks passed
@gforsyth gforsyth deleted the fix_docstring_rendering branch December 6, 2024 13:14
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.

docs(quartodoc): render_methods is showing arguments as a list
3 participants