Skip to content

Clean descriptions #266

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

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Clean descriptions #266

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4033906
chore: Remove return type references from description field
nielsbasjes Jul 5, 2025
24ef73a
chore: Fix spaces in descriptions
nielsbasjes Jul 5, 2025
2a5a053
chore: Make all descriptions end with a period.
nielsbasjes Jul 5, 2025
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
20 changes: 10 additions & 10 deletions json/model_1.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
{
"group": {
"desc": "All SunSpec compliant devices must include this as the first model",
"desc": "All SunSpec compliant devices must include this as the first model.",
"label": "Common",
"name": "common",
"points": [
{
"desc": "Model identifier",
"desc": "Model identifier.",
"label": "Model ID",
"mandatory": "M",
"name": "ID",
Expand All @@ -18,7 +18,7 @@
]
},
{
"desc": "Model length",
"desc": "Model length.",
"label": "Model Length",
"mandatory": "M",
"name": "L",
Expand All @@ -30,7 +30,7 @@
]
},
{
"desc": "Well known value registered with SunSpec for compliance",
"desc": "Well known value registered with SunSpec for compliance.",
"label": "Manufacturer",
"mandatory": "M",
"name": "Mn",
Expand All @@ -42,7 +42,7 @@
]
},
{
"desc": "Manufacturer specific value (32 chars)",
"desc": "Manufacturer specific value (32 chars).",
"label": "Model",
"mandatory": "M",
"name": "Md",
Expand All @@ -54,7 +54,7 @@
]
},
{
"desc": "Manufacturer specific value (16 chars)",
"desc": "Manufacturer specific value (16 chars).",
"label": "Options",
"name": "Opt",
"size": 8,
Expand All @@ -63,7 +63,7 @@
"standards": []
},
{
"desc": "Manufacturer specific value (16 chars)",
"desc": "Manufacturer specific value (16 chars).",
"label": "Version",
"name": "Vr",
"size": 8,
Expand All @@ -74,7 +74,7 @@
]
},
{
"desc": "Manufacturer specific value (32 chars)",
"desc": "Manufacturer specific value (32 chars).",
"label": "Serial Number",
"mandatory": "M",
"name": "SN",
Expand All @@ -87,7 +87,7 @@
},
{
"access": "RW",
"desc": "Modbus device address",
"desc": "Modbus device address.",
"detail": "This point is mandatory for all SunSpec RTU devices and, for those devices, they must support values from 1-247.",
"label": "Device Address",
"name": "DA",
Expand All @@ -96,7 +96,7 @@
"standards": []
},
{
"desc": "Force even alignment",
"desc": "Force even alignment.",
"name": "Pad",
"size": 1,
"static": "S",
Expand Down
12 changes: 6 additions & 6 deletions json/model_10.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
{
"group": {
"desc": "To be included first for a complete interface description",
"desc": "To be included first for a complete interface description.",
"label": "Communication Interface Header",
"name": "model_10",
"points": [
{
"desc": "Model identifier",
"desc": "Model identifier.",
"label": "Model ID",
"mandatory": "M",
"name": "ID",
Expand All @@ -15,7 +15,7 @@
"value": 10
},
{
"desc": "Model length",
"desc": "Model length.",
"label": "Model Length",
"mandatory": "M",
"name": "L",
Expand All @@ -24,7 +24,7 @@
"type": "uint16"
},
{
"desc": "Overall interface status",
"desc": "Overall interface status.",
"label": "Interface Status",
"mandatory": "M",
"name": "St",
Expand All @@ -47,14 +47,14 @@
},
{
"access": "RW",
"desc": "Overall interface control (TBD)",
"desc": "Overall interface control (TBD).",
"label": "Interface Control",
"name": "Ctl",
"size": 1,
"type": "uint16"
},
{
"desc": "Enumerated value. Type of physical media",
"desc": "Type of physical media.",
"label": "Physical Access Type",
"name": "Typ",
"size": 1,
Expand Down
Loading