Skip to content

Commit b5199da

Browse files
committed
[Traits] Unify YAML new line handling
Ensures that we're not inadvertently hard-wrapping docstrings and such in the wrong places. Many YAML is confusing in this respect. Signed-off-by: Tom Cowland <[email protected]>
1 parent bec7306 commit b5199da

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

traits.yml

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,23 +43,26 @@ traits:
4343
properties:
4444
name:
4545
type: string
46-
description: |
46+
description: >
4747
The humanized name of entity itself, not including any
4848
hierarchy or classification.
4949
50+
5051
For example:
5152
- `"Cuttlefish v1"` - for a version of an asset
5253
- `"seq003"` - for a sequence in a hierarchy
5354
5455
qualifiedName:
5556
type: string
56-
description: |
57+
description: >
5758
An unambiguous, humanised name for the entity.
5859
60+
5961
The display name may want to consider the host, and any other
6062
relevant Context information to form a display name for an
6163
entity that can uniquely identify the entity in that context.
6264
65+
6366
For example:
6467
- `"dive / build / cuttlefish / model / v1"` for a version
6568
of an asset in an 'open recent' menu.

0 commit comments

Comments
 (0)