apache / iceberg

Apache Iceberg
https://iceberg.apache.org/
Apache License 2.0
6.49k stars 2.24k forks source link

Docs: Use the correct YAML text block indicator to prevent formatting issues #11552

Open neodon opened 1 week ago

neodon commented 1 week ago

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

neodon commented 6 days ago

Pardon the (probably) unnecessary merge.