revert #17315 (keeping good parts) #17528
Closed
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.
@timotheecour , @xflywind., I have to take back my approve of #17315 . I'm very sorry because I also added some confusion.
New examples presented by @timotheecour in nim-lang/RFCs#355 (comment) showed that #17315 was a really bad idea.
We lost the way to format code like:
It worked fine before:
The essence of the entire problem is that rst2html.py has 2 backslash modes:
\
properly in nim doc, rst2html #17315 moved to. (This also matches the actual behavior of rst2html.py with:code:
role)We really should stick to number 1 because:
\\
it's OK — it matches Nim programming languages escaping in strings"\\"
`beginning of code \ `
, though that currently did not work in Nim)The good things of 2. is that it matches Markdown behavior better and that it allows to type backslashe as single backslash (unescaped).
Now I actually think that the behavior of rst2html.py with
:code:
role should never be replicated in Nim. It's a wrong design. Let us just proclaim that we conform to the spec better.In this PR I left relevant test cases from #17315 and changed the function doc comment from original bug #17260 to render properly with old syntax.
cc @narimiran