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

[Docs] Fix examples section of several API references #661

Merged
merged 10 commits into from
Aug 29, 2024

Conversation

maxschulz-COL
Copy link
Contributor

Description

Missing : does not render docs examples properly

Screenshot

Notice

  • I acknowledge and agree that, by checking this box and clicking "Submit Pull Request":

    • I submit this contribution under the Apache 2.0 license and represent that I am entitled to do so on behalf of myself, my employer, or relevant third parties, as applicable.
    • I certify that (a) this contribution is my original creation and / or (b) to the extent it is not my original creation, I am authorized to submit this contribution on behalf of the original creator(s) or their licensees.
    • I certify that the use of this contribution as authorized by the Apache 2.0 license does not violate the intellectual property rights of anyone else.
    • I have not referenced individuals, products or companies in any commits, directly or indirectly.
    • I have not added data or restricted code in any commits, directly or indirectly.

@petar-qb
Copy link
Contributor

@maxschulz-COL your changes are overwritten by pre-commit-ci.

@maxschulz-COL
Copy link
Contributor Author

@maxschulz-COL your changes are overwritten by pre-commit-ci.

What a bummer...

Copy link
Contributor

@huong-li-nguyen huong-li-nguyen left a comment

Choose a reason for hiding this comment

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

All good from my side 👍 Seems like the docs don't like the typing for the kwargs argument though 😅 Hope we can fix it easily 🤞

vizro-core/tests/tests_utils/asserts.py Show resolved Hide resolved
vizro-core/src/vizro/tables/_dash_ag_grid.py Show resolved Hide resolved
Copy link
Contributor

@petar-qb petar-qb left a comment

Choose a reason for hiding this comment

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

After applying Li's suggestions, this is going to be ready for merge by my opinion 👍

vizro-core/tests/tests_utils/asserts.py Show resolved Hide resolved
@maxschulz-COL
Copy link
Contributor Author

Just for reference, the initial behaviour was actually a bug: astral-sh/ruff#13139

This PR fixes those issues though, but will be goof to remember for posterity

@maxschulz-COL maxschulz-COL enabled auto-merge (squash) August 29, 2024 09:59
@maxschulz-COL maxschulz-COL merged commit 8c97a3c into main Aug 29, 2024
31 of 32 checks passed
@maxschulz-COL maxschulz-COL deleted the docs/fix_example_rendering branch August 29, 2024 09:59
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.

3 participants