Skip to content

Format docs with ruff formatter#13087

Merged
dhruvmanila merged 10 commits intoastral-sh:mainfrom
calumy:format-with-ruff
Aug 26, 2024
Merged

Format docs with ruff formatter#13087
dhruvmanila merged 10 commits intoastral-sh:mainfrom
calumy:format-with-ruff

Conversation

@calumy
Copy link
Copy Markdown
Contributor

@calumy calumy commented Aug 24, 2024

Summary

Now that Ruff provides a formatter, there is no need to rely on Black to check that the docs are formatted correctly in check_docs_formatted.py. This PR swaps out Black for the Ruff formatter and updates inconsistencies between the two.

This PR will be a precursor to another PR (branch), updating the check_docs_formatted.py script to check for pyi files, fixing #11568.

Test Plan

  • CI to check that the docs are formatted correctly using the updated script.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Aug 24, 2024

ruff-ecosystem results

Linter (stable)

✅ ecosystem check detected no linter changes.

Linter (preview)

✅ ecosystem check detected no linter changes.

Formatter (stable)

✅ ecosystem check detected no format changes.

Formatter (preview)

✅ ecosystem check detected no format changes.

@dhruvmanila dhruvmanila added the ci Related to internal CI tooling label Aug 26, 2024
@calumy calumy requested a review from dhruvmanila August 26, 2024 14:34
Copy link
Copy Markdown
Member

@dhruvmanila dhruvmanila left a comment

Choose a reason for hiding this comment

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

Thanks!

@dhruvmanila
Copy link
Copy Markdown
Member

Re-running the failed jobs, not sure what happened there

@dhruvmanila dhruvmanila merged commit ab3648c into astral-sh:main Aug 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci Related to internal CI tooling

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants