Skip to content

Conversation

@marbens-arch
Copy link
Member

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!

First error (introduced in syncthing#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]>
@marbens-arch marbens-arch marked this pull request as draft October 31, 2025 20:41
Signed-off-by: Marcus B Spencer <[email protected]>
@marbens-arch marbens-arch marked this pull request as ready for review October 31, 2025 20:49
@calmh calmh merged commit 306dac9 into syncthing:main Nov 1, 2025
4 checks passed
@marbens-arch marbens-arch deleted the fix-relay-spec-formatting-errors branch November 1, 2025 15:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants