From dbeb25741a99c08af31ab03234fde612ee20f059 Mon Sep 17 00:00:00 2001
From: Stefan Lippuner <3071885+stefanlippuner@users.noreply.github.com>
Date: Tue, 14 Nov 2023 14:37:28 +0100
Subject: [PATCH] Doc - Add a short note on newlines in the description field

---
 doc/cheby-ug.txt | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/doc/cheby-ug.txt b/doc/cheby-ug.txt
index 2fd58726..868faef8 100644
--- a/doc/cheby-ug.txt
+++ b/doc/cheby-ug.txt
@@ -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.