Skip to content

Commit

Permalink
docs: tweak some wording in syntax page
Browse files Browse the repository at this point in the history
  • Loading branch information
h4l committed Aug 9, 2023
1 parent 4830c94 commit 486bf94
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions docs/syntax.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,17 +18,17 @@ that are merged into the host object or array.
Keys can be prefixed with [Flags](#flags) to control their behaviour when
missing/empty.

![argument diagram](syntax-diagrams/key.svg)

### `key-value`

Keys starting with `@` are references to variables or files. (File references
start with `/` or `./`, otherwise they're variables). Otherwise, the key's value
is a literal string. Values that use flag characters need to start with an `=`.

The main value of a key can be any character, except `:` which starts a
[`meta`](#meta) section, and `@` or `=` which start a [`value`](#value). To
include these characters in keys, they must be escaped by doubling them.
![argument diagram](syntax-diagrams/key.svg)

### `key-value`

The value of a key can be any character, except `:` which starts a
[`metadata`](#metadata) section, and `@` or `=` which start a [`value`](#value).
To include these characters in keys, they must be escaped by doubling them.

![argument diagram](syntax-diagrams/key-value.svg)

Expand Down

0 comments on commit 486bf94

Please sign in to comment.