Escape the multiline-comment end sequence '*/' in doc comments #3
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
…doc comment. The escaped sequence looks like this: '*\/'.
Merged
2 tasks
AntonyBlakey
approved these changes
Nov 28, 2024
github-merge-queue bot
pushed a commit
to NomicFoundation/slang
that referenced
this pull request
Dec 12, 2024
…#1169) When generating documentation for `TerminalKind` and `NonterminalKind`, generate the EBNF grammar for the current variant and include that in the final output. This affects the Wit output and Rust output (using templates `cst.wit.jinja2` and `(terminal|nonterminal)_kind.rs.jinja2`). * [x] Depends on #1157 * [x] Depends on NomicFoundation/jco#3 Closes #1165
github-merge-queue bot
pushed a commit
to NomicFoundation/slang
that referenced
this pull request
Dec 12, 2024
…#1169) When generating documentation for `TerminalKind` and `NonterminalKind`, generate the EBNF grammar for the current variant and include that in the final output. This affects the Wit output and Rust output (using templates `cst.wit.jinja2` and `(terminal|nonterminal)_kind.rs.jinja2`). * [x] Depends on #1157 * [x] Depends on NomicFoundation/jco#3 Closes #1165
github-merge-queue bot
pushed a commit
to NomicFoundation/slang
that referenced
this pull request
Dec 12, 2024
…#1169) When generating documentation for `TerminalKind` and `NonterminalKind`, generate the EBNF grammar for the current variant and include that in the final output. This affects the Wit output and Rust output (using templates `cst.wit.jinja2` and `(terminal|nonterminal)_kind.rs.jinja2`). * [x] Depends on #1157 * [x] Depends on NomicFoundation/jco#3 Closes #1165
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.
This fixes an issue I encountered when adding EBNF documentation to the TerminalKind and NonterminalKind enums. The TerminalKind variants "MultilineComment" and "MultiLineNatSpecComment" both print out the sequence "*/", but this sequence ends the current doc comment and then causes the rest of the file to be parsed incorrectly. By escaping this sequence we avoid this issue, but the generated docs still show the correct string.
The escaped sequence looks like this: '*/'.