chore(all): fix various RST file formatting errors #961
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Fix various RST formatting errors as reported by Sphinx when building HTML for the Docs. Signed-off-by: Tomasz Wilczyński <[email protected]>
acolomb
approved these changes
Sep 7, 2025
marbens-arch
added a commit
to marbens-arch/syncthing-docs
that referenced
this pull request
Oct 31, 2025
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]>
calmh
pushed a commit
that referenced
this pull request
Nov 1, 2025
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]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
chore(all): fix various RST file formatting errors
Fix various RST formatting errors as reported by Sphinx when building
HTML for the Docs.
Signed-off-by: Tomasz Wilczyński [email protected]