Parse code blocks metadata #2
Merged
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
The metadata string, if present, is required to start with the language
tag. The code block AST node is now:
(language tag * metadata option) option * content
Newlines were already allowed by lack of restrictions on the second field. This commit allows them explicitly and improve edge cases.
Documentation comments cannot be attached to polymorphic variant constructors.
This was referenced Aug 3, 2021
|
It looks like we are missing tests for the new functionality? |
|
Which test is missing ? The previous tests are still useful, there are new tests for the edge cases of the new "parsing" code. |
|
Huh, you're absolutely right, I've no idea why I didn't see that first time! |
Merged
jonludlam
added a commit
to jonludlam/opam-repository
that referenced
this pull request
Dec 11, 2021
CHANGES: - New syntax to allow associating metadata with code blocks (@Julow, ocaml-doc/odoc-parser#2, ocaml-doc/odoc-parser#3)
jonludlam
pushed a commit
to jonludlam/odoc-parser
that referenced
this pull request
Feb 22, 2023
Fix new paragraph starting on `|`
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.
The first commit parses the "metadata" string that can be attached to code blocks into two fields: the language tag and the arbitrary metadata string. The AST node is changed to
The second field is parsed as before, it takes any characters until the first
[, there's no escaping and it doesn't strip trailing whitespaces.The first field is parsed as a word (a new definition of "word"). It is mandatory when using the
{@lang metadata[ ... ]}syntax.The second commit allows newlines between the two fields. Newlines were already allowed but were treated as part of the second field.
The parsing of code blocks still has rough edges (eg. lack of escaping, including the trailing whitespaces) but this shouldn't make it worse.