https://stylepedia.net/style/#referring-punc-special-chars
Example 2.5. Referring to Special Characters
"The hyphen after the greater-than symbol (>) indicates that a newline character (\n) is not added to the end of the variable."
This statement refers to the use of chomping characters (in this case >-), and it uses a minus sign, not a hyphen. They are two different things, although in many cases you'd struggle to tell the difference.
We should also s/variable/string/ because this is talking about basic YAML (you'll see it all the time in outline.yml) and using "variable" could be misleading.
The existing statement also reads "is not added" which is not 100% correct. The use of >- means that any newline characters are stripped from the end of the string.
https://stylepedia.net/style/#referring-punc-special-chars
Example 2.5. Referring to Special Characters
"The hyphen after the greater-than symbol (>) indicates that a newline character (\n) is not added to the end of the variable."
This statement refers to the use of chomping characters (in this case >-), and it uses a minus sign, not a hyphen. They are two different things, although in many cases you'd struggle to tell the difference.
We should also s/variable/string/ because this is talking about basic YAML (you'll see it all the time in outline.yml) and using "variable" could be misleading.
The existing statement also reads "is not added" which is not 100% correct. The use of >- means that any newline characters are stripped from the end of the string.