Skip to content

Commit

Permalink
Doc - Add a short note on newlines in the description field
Browse files Browse the repository at this point in the history
  • Loading branch information
stefanlippuner committed Nov 14, 2023
1 parent f57958a commit dbeb257
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion doc/cheby-ug.txt
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,10 @@ to make it more readable. This attribute is not required but it is recommended
to always provide it.

* `description`: This is a longer text that will be copied into the generated
documentation.
documentation. Newlines are honored according to the YAML specification. In
regular strings, you can add an empty line to generate a newline.
Alternatively, you can also explicitely add them in double-quoted strings,
e.g. `description: "line1 \n line2"`.

* `children`: For nodes that have children, this is a list of the children.

Expand Down

0 comments on commit dbeb257

Please sign in to comment.