Move deviations from formatter README to documentation #10444
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
MichaReiser
force-pushed
the
formatter-2024-deviations
branch
from
6b65eb4 to
a061dcf
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
#10151 documented the deviations between Ruff and Black with the new 2024 style guide in the
ruff-python-formatter/README.md. However, that's not the documentation shownon the website when navigating to intentional deviations.
This PR streamlines the
ruff-python-formatter/README.mdand links to the documentation on the website instead of repeating the same content.The PR also makes the 2024 style guide deviations available on the website documentation.
Test Plan
I built the documentation locally and verified that the 2024 style guide known deviations are now shown on the website.