Fix description of 'core:version' and creation of short-descriptions

sigmf · Dec 18, 2024 · 4d50f24 · 4d50f24
1 parent dfd1584
commit 4d50f24
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git 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
@@ -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"
         },