squash: docs

teemtee · Jan 13, 2025 · 5467319 · 5467319
1 parent 11e180a
commit 5467319
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 4 deletions.
diff --git a/docs/releases.rst b/docs/releases.rst
@@ -17,6 +17,8 @@ The :ref:`/plugins/report/reportportal` plugin now exports all
 test contact information, rather than just the first contact
 instance.
 
+The ``note`` field of tmt :ref:`/spec/plans/results` changes from
+a string to a list of strings, to better accommodate multiple notes.
 
 tmt-1.40.0
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

diff --git a/spec/plans/results.fmf b/spec/plans/results.fmf
@@ -35,7 +35,7 @@ description: |
 
        # List of strings, optional comments to report with the result.
        note:
-         - "Things were great."
+         - Things were great.
 
        # List of strings, paths to log files.
        log:
@@ -91,7 +91,7 @@ description: |
 
           # List of strings, optional comments to report with the result.
           note:
-            - "Things were great."
+            - Things were great.
 
           # List of strings, paths to logs files.
           log:
@@ -130,7 +130,7 @@ description: |
 
           # List of strings, optional comments to report with the result.
           note:
-            - "Things were great."
+            - Things were great.
 
           # List of strings, paths to log files.
           log:
@@ -259,6 +259,9 @@ description: |
     .. versionchanged:: 1.37
        original result of test, subtest and check is stored in ``original-result`` key.
 
+    .. versionchanged:: 1.41
+       ``note`` field changed from a string to a list of strings.
+
     __ https://github.com/teemtee/tmt/blob/main/tmt/schemas/results.yaml
 
 example:
@@ -359,7 +362,7 @@ example:
         "result": "pass",
         "log": ["pass_log"],
         "duration": "00:11:22",
-        "note": "good result"
+        "note": ["good result"]
       }
     ]