Docs: Use the correct YAML text block indicator to prevent formatting issues #11552
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
… issues. In the Spark Quickstart guide, the initial docker-compose example specifies an entrypoint script in a multi-line string. The string is mistakenly started with the 'folded style' indicator `>`, which causes formatters to collapse it into one line. Changing to the 'literal style' indicator `|` resolves the issue and preserves formatting. Folded Style: <https://yaml.org/spec/1.2.2/#813-folded-style> Literal Style: <https://yaml.org/spec/1.2.2/#812-literal-style>
jbonofre
approved these changes
Nov 15, 2024
|
Pardon the (probably) unnecessary merge. |
hussein-awala
suggested changes
Nov 20, 2024
|
This pull request has been marked as stale due to 30 days of inactivity. It will be closed in 1 week if no further activity occurs. If you think that’s incorrect or this pull request requires a review, please simply write any comment. If closed, you can revive the PR at any time and @mention a reviewer or discuss it on the [email protected] list. Thank you for your contributions. |
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.
In the Spark Quickstart guide, the initial docker-compose example specifies an entrypoint script in a multi-line string. The string is mistakenly started with the 'folded style' indicator
>, which causes formatters to collapse it into one line.Changing to the 'literal style' indicator
|resolves the issue and preserves formatting.Folded Style: https://yaml.org/spec/1.2.2/#813-folded-style
Literal Style: https://yaml.org/spec/1.2.2/#812-literal-style