Skip to content

Commit b6aeb5d

Browse files
committed
#399 - Update SPEC for long string
Signed-off-by: Chin Yeung Li <[email protected]>
1 parent 2345686 commit b6aeb5d

File tree

1 file changed

+12
-6
lines changed

1 file changed

+12
-6
lines changed

SPECIFICATION.rst

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -118,21 +118,27 @@ trailing white spaces: they must be ignored.
118118

119119
The field value is composed of one or more lines of plain US-ASCII printable text.
120120

121-
When a field value contains more than one line of text, a 'literal block'
122-
(using |), or a 'folded block' (using '>') is need.
121+
When a field value is a long string, additional continuation lines must start
122+
with at least one space. In this case, the first space of an additional
123+
continuation line is ignored and should be removed from the field value by tools.
123124

124125
For instance::
125126

126-
description: >
127-
This is a long description for a software component that spans
128-
multiple lines with arbitrary line breaks.
127+
description: This is a long description for a
128+
software component that additional continuation line is used.
129129

130-
or::
130+
131+
When a field value contains more than one line of text, a 'literal block'
132+
(using |) is need.
133+
134+
For instance::
131135

132136
description: |
133137
This is a long description for a software component that spans
134138
multiple lines with arbitrary line breaks.
135139

140+
This text contains multiple lines.
141+
136142

137143
Fields are mandatory or optional
138144
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

0 commit comments

Comments
 (0)