chore: harmonize format of YAML samples in README.md #117
+16
−16
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
|
Thanks for opening this PR! Can you provide an exact reference in the spec stating this is how it needs to be formatted? I ran the latest version of Regardless, we're using the indented version elsewhere (e.g., in Ruff CI workflow https://github.com/astral-sh/ruff/blob/main/.github/workflows/ci.yaml) so I'd prefer to keep it that way for now. |
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
This PR ensures consistent formatting of sample configuration snippets in YAML format.
The format is now similar to the one shown in the official YAML spec; Example 2.12.
Test Plan
I am using shown configuration samples as-is in my personal projects.