Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

馃摑 Update guidance for upstream issues #2759

Merged
merged 2 commits into from Dec 20, 2022
Merged

馃摑 Update guidance for upstream issues #2759

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
03bc950
馃摑 Update guidance for upstream issues
CollierCZ Dec 19, 2022
a7cc502
Merge branch 'main' into code-spacing
CollierCZ Dec 20, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
20 changes: 20 additions & 0 deletions contributing/markup-format.md
View file
Open in desktop
Expand Up @@ -259,6 +259,26 @@ web:
Keep the top-level key visible so readers can understand the code in context.
(For example, don't leave out `web:` in the example above.)

### Multiline strings

When writing multiline strings in YAML, known as scalar content,
examples often use a literal style as shown with a `|`.
In such cases, the string that comes needs to span multiple lines.
Otherwise, the parser doesn't accept it as a scalar and the spacing and highlighting is wrong.

To resolve this, either put the comment on a single line without the `|`
or add an ellipsis to indicate content is missing, as in the following example:

```yaml
hooks:
build: |
...
git pull
```

The highlighter also adds extra whitespace at the end of multiline strings.
These are [known issues](https://github.com/alecthomas/chroma/issues/475).

### Note when low-level items are missing

If there's a complicated block (such as `web.locations`) with many settings not relevant to the current idea,
Expand Down