From 4d50f24cb820f93a566928106c95ffd431574223 Mon Sep 17 00:00:00 2001 From: bbc131 <36670201+bbc131@users.noreply.github.com> Date: Tue, 17 Dec 2024 16:37:01 +0100 Subject: [PATCH] Fix description of 'core:version' and creation of short-descriptions --- docs-generator.py | 2 +- sigmf-schema.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs-generator.py b/docs-generator.py index 46f7e24..45f5d93 100644 --- a/docs-generator.py +++ b/docs-generator.py @@ -34,7 +34,7 @@ def gen_table(table, d): dtype = value.get("type", "MISSING") # default = str(value.get("default", "")) longdescription = value.get("description", "") - shortdescription = longdescription[: longdescription.find(".")].replace("\n", "") # short description, which is up to the first period + shortdescription = longdescription[: longdescription.find(". ")].replace("\n", "") # short description, which is up to the first period followed by space table.add_row((field, required, dtype, shortdescription)) table.append(NoEscape("\\bottomrule")) diff --git a/sigmf-schema.json b/sigmf-schema.json index 5cc9c2d..c462274 100644 --- a/sigmf-schema.json +++ b/sigmf-schema.json @@ -94,7 +94,7 @@ "maximum": 18446744073709552000 }, "core:version": { - "description": "The version of the SigMF specification used to create the Metadata file, in the format X.Y.Z", + "description": "The version of the SigMF specification used to create the Metadata file, in the format X.Y.Z.", "pattern": "^\\d+\\.\\d+\\.\\d", "type": "string" },