Skip to content

Commit 306dac9

Browse files
authored
fix(specs): fix relay formatting errors (#970)
First error (introduced in #961) fixed is where the "The relay immediately terminates the connection after sending this." is not included in the enumeration above. That statement only applies in the case of RelayFull. Second error is that the response codes right after the "Protocol defined responses" comment are actually considered a part of the comment because the indentation level is 1 higher, and therefore won't be displayed. According to https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#comments: > Arbitrary indented text may be used on the lines following the explicit markup start: > ``` > .. This is a comment > .. > _so: is this! > ``` --------- Signed-off-by: Marcus B Spencer <[email protected]>
1 parent c31511c commit 306dac9

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

specs/relay-v1.rst

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -132,8 +132,7 @@ messages:
132132
2. ResponseAlreadyConnected - Session is full (both sides already connected)
133133
3. ResponseSuccess - You have successfully joined the session
134134
4. RelayFull - Relay limits are too strict for you to be able to join the session.
135-
136-
The relay immediately terminates the connection after sending this.
135+
The relay immediately terminates the connection after sending this.
137136

138137
After the successful response, all the bytes written and received will be
139138
relayed between the two devices in the session directly.
@@ -288,11 +287,14 @@ Response message (Type = 4)
288287
Message associated with the code.
289288

290289
.. Protocol defined responses:
291-
1. ResponseSuccess = Response{0, "success"}
292-
2. ResponseNotFound = Response{1, "not found"}
293-
3. ResponseAlreadyConnected = Response{2, "already connected"}
294-
4. ResponseInternalError = Response{99, "internal error"}
295-
5. ResponseUnexpectedMessage = Response{100, "unexpected message"}
290+
291+
::
292+
293+
ResponseSuccess = Response{0, "success"}
294+
ResponseNotFound = Response{1, "not found"}
295+
ResponseAlreadyConnected = Response{2, "already connected"}
296+
ResponseInternalError = Response{99, "internal error"}
297+
ResponseUnexpectedMessage = Response{100, "unexpected message"}
296298

297299
ConnectRequest message (Type = 5)
298300
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

0 commit comments

Comments
 (0)