Conversation
| json | ||
| ~~~ json | ||
| { | ||
| "localPlayerToken" : UUID, |
There was a problem hiding this comment.
This was intending to specify the returned type, as per the table at the top of the document.
There was a problem hiding this comment.
It's confusing, because the markdown indicates it's a valid json block; probably the right fix is remove the json indicator, and have a convention for annotating types, as opposed to what appears to be a literal. That comment would apply to all the json markdown I've had a go at in this PR.
There was a problem hiding this comment.
OK, so perhaps xxxxxxxx-xxxx-Mxxx-Nxxx-xxxxxxxxxxxx for UUID values
| json | ||
| ~~~ json | ||
| { "connectionToken" : UUID } | ||
| { "connectionToken" : "$UUID" } |
There was a problem hiding this comment.
UUID is a type and not intended to name a variable here.
| json | ||
| ~~~ json | ||
| { "data" : Data } | ||
| { "data" : "$uuencodedData" } |
There was a problem hiding this comment.
We can add a Url encoded Data type to the Types table. Here it is not needed as the response can be any string. Only the request URL needs escaping.
| ~~~ | ||
|
|
||
| json | ||
| ~~~ json |
There was a problem hiding this comment.
I'd prefer to leave the syntax highlighting marker there
There was a problem hiding this comment.
The marker indicates that the block following is valid json, which it isn't. All the red blocks in the rendered view are error highlighters, it's confusing when using a highlighting editor, because as long as the invalid blocks are in the source, the editor will always report "there are problems in this file".
|
|
||
| This connection may be truly peer-to-peer but if reachability is an issue it may be tunneled through a STUN or TURN server. An implementation detail the client does not need to worry about. | ||
|
|
||
|
|
There was a problem hiding this comment.
Pity there is no way to show markdeep in GitHub
There was a problem hiding this comment.
Yes, 100%. I'm currently treating the markdeep header/footer as something that happens in a publish step. Those lines are wreaking havoc in all the wysiwyg markdown editors I use.
2 participants
No description provided.