Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 1 commit into from
Dec 19, 2024
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs-generator.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"))

Expand Down
2 changes: 1 addition & 1 deletion sigmf-schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
},
Expand Down
Loading