Skip to content

fix(docs): @utils.use_signature formatting#3450

Merged
mattijn merged 2 commits intovega:mainfrom
dangotbanned:fix-use-signature-docs
Jun 30, 2024
Merged

fix(docs): @utils.use_signature formatting#3450
mattijn merged 2 commits intovega:mainfrom
dangotbanned:fix-use-signature-docs

Conversation

@dangotbanned
Copy link
Member

@dangotbanned dangotbanned commented Jun 29, 2024

Related to #3444 (comment)

Ready for review

API Functions

Before

image

After

*This change isn't related to the sphinx theme, which seems to be on a newer version. See table issue

image

Example (binding_radio)

Before

image

After

image

Misc

I didn't go through trying to fully resolve the mypy issues with @utils.use_signature.
However, I've updated the comments for future reference.

Related to vega#3444 (comment)

*Placeholder for screenshot(s) documenting the bug*
@dangotbanned dangotbanned changed the title docs: Fix use_signature formatting issue docs: Fix @utils.use_signature formatting Jun 29, 2024
@dangotbanned dangotbanned changed the title docs: Fix @utils.use_signature formatting fix(docs): @utils.use_signature formatting Jun 29, 2024
@mattijn
Copy link
Contributor

mattijn commented Jun 30, 2024

Good find! Thanks @dangotbanned!

@mattijn mattijn merged commit 7f05ecb into vega:main Jun 30, 2024
@dangotbanned dangotbanned deleted the fix-use-signature-docs branch June 30, 2024 21:03
@joelostblom joelostblom added the bug label Jul 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants