Don't throw errors on RST tables in Markdown and RstMarkdown modes #22165
Conversation
This file contains 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
Additions to RST simple tables (nim-lang#19859) made their parsing more restrictive, which can introduce problems with of some old nimforum posts, which have tables with sloppily aligned columns (like this one: nim-lang/nimforum#330 (comment)). Also this strictness contradicts to Markdown style of not getting in the way (ignoring errors). So this PR proposes a new strategy of dealing with errors: * In Markdown and legacy (old default) RstMarkdown we try to continue parsing, emitting only warnings * And only in pure RST mode we throw a error I expect that this strategy will be applied to more parts of markup code in the future.
Araq
reviewed
Jun 27, 2023
lib/packages/docutils/rst.nim
Outdated
| @@ -2593,14 +2616,14 @@ proc getColumns(p: RstParser, cols: var RstCols, startIdx: int): int = | |||
| if p.tok[result].kind != tkAdornment: break | |||
| if p.tok[result].kind == tkIndent: inc result | |||
|
|
|||
| proc checkColumns(p: RstParser, cols: RstCols) = | |||
| proc checkColumns(p: RstParser, cols: RstCols): bool = | |||
There was a problem hiding this comment.
What's the point of always returning true?
There was a problem hiding this comment.
silly me. Wanted to abort parsing table in some cases, but then decided it's not worth it. Reverted.
|
Thanks for your hard work on this PR! Hint: mm: orc; opt: speed; options: -d:release |
bung87
pushed a commit
to bung87/Nim
that referenced
this pull request
Jul 29, 2023
…im-lang#22165) * Don't throw errors on RST tables in Markdown and RstMarkdown modes Additions to RST simple tables (nim-lang#19859) made their parsing more restrictive, which can introduce problems with of some old nimforum posts, which have tables with sloppily aligned columns (like this one: nim-lang/nimforum#330 (comment)). Also this strictness contradicts to Markdown style of not getting in the way (ignoring errors). So this PR proposes a new strategy of dealing with errors: * In Markdown and legacy (old default) RstMarkdown we try to continue parsing, emitting only warnings * And only in pure RST mode we throw a error I expect that this strategy will be applied to more parts of markup code in the future. * Don't return anything in `checkColumns`
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Additions to RST simple tables (#19859) made their parsing more restrictive, which can introduce problems with of some old nimforum posts, which have tables with sloppily aligned columns (like this one:
nim-lang/nimforum#330 (comment)). Also this strictness contradicts to Markdown style of not getting in the way (ignoring errors).
So this PR proposes a new strategy of dealing with errors:
I expect that this strategy will be applied to more parts of markup code in the future.