linse/frappy
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc: Fix escapes.

Browse Source 
Change-Id: If0abff5e259eeaa66c4b8357b72e4f9f2646531c
This commit is contained in:
Alexander Lenz 2017-09-13 15:41:51 +02:00
parent 4e1dd2507e
commit ffd84c4b6e
2 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/source/protocol/jsonstruct.rst
View File

@ -58,11 +58,11 @@ vorerst folgende Festlegung:
"firmware": "The SECoP playground", "firmware": "The SECoP playground",
"modules": ["cryo", {"commands": ["stop", {"resulttype": "None", "modules": ["cryo", {"commands": ["stop", {"resulttype": "None",
"arguments": "[]", "arguments": "[]",
"description": "Testing command implementation\n\nwait a second" "description": "Testing command implementation\\n\\nwait a second"
}, },
"start", {"resulttype": "None", "start", {"resulttype": "None",
"arguments": "[]", "arguments": "[]",
"description": "normally does nothing,\n\nbut there may be modules which _start_ the action here\n" "description": "normally does nothing,\\n\\nbut there may be modules which _start_ the action here\\n"
} }
], ],
"group": "very important/stuff", "group": "very important/stuff",

8
doc/source/protocol/messages.rst
View File

@ -7,9 +7,9 @@ All Messages are formatted in the same way:
where [] enclose optional parts. This basically results in 3 different possible where [] enclose optional parts. This basically results in 3 different possible
formattings: formattings:
* type A: "keyword\n" * type A: "keyword\\n"
* type B: "keyword specifier\n" * type B: "keyword specifier\\n"
* type C: "keyword specifier JSON_data\n" * type C: "keyword specifier JSON_data\\n"
Note: numerical values and strings appear 'naturally' formatted in JSON, i.e. 5.0 or "a string" Note: numerical values and strings appear 'naturally' formatted in JSON, i.e. 5.0 or "a string"
@ -23,7 +23,7 @@ On change-requests the parameter is assumed to be 'target', on trigger-requests
Clients should not rely on this and explicitly state the parametername! Clients should not rely on this and explicitly state the parametername!
All names and keywords are defined to be identifiers in the sense, that they are not longer than 63 characters and consist only of letters, digits and underscore and do not start with a digit. (i.e. T_9 is ok, whereas t{9} is not!) All names and keywords are defined to be identifiers in the sense, that they are not longer than 63 characters and consist only of letters, digits and underscore and do not start with a digit. (i.e. T_9 is ok, whereas t{9} is not!)
No rule is without exception, there is exactly ONE special case: the identify request consists of the literal string '*IDN?\n' and its answer is formatted like an valid SCPI response for *IDN?. No rule is without exception, there is exactly ONE special case: the identify request consists of the literal string '*IDN?\\n' and its answer is formatted like an valid SCPI response for *IDN?.
We rely on the underlying transport to not split messages, i.e. all messages are transported as a whole and no message interrupts another. We rely on the underlying transport to not split messages, i.e. all messages are transported as a whole and no message interrupts another.