render EBNF grammar in node kind enums doc comments#545
Merged
OmarTawfik merged 1 commit intomainfrom Jul 24, 2023
Merged
Conversation
🦋 Changeset detectedLatest commit: b7ef3a7 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
6395685 to
21f916b
Compare
c8ef711 to
d13f8bd
Compare
OmarTawfik
commented
Jul 17, 2023
|
|
||
| // Constructs all documentation headers for the given production, including any sub-statements | ||
| // It returns a map from each statement name to its markdown documentation: | ||
| fn extract_documentation( |
Contributor
Author
There was a problem hiding this comment.
This looks like a good candidate to refactor the shared EBNF serializer to produce documentation in a single place for all three consumers. However, we are changing how we do versioning soon, so I decided to keep this for now.
AntonyBlakey
approved these changes
Jul 18, 2023
Closed
Closed
21f916b to
84715f9
Compare
d13f8bd to
3f80c57
Compare
3f80c57 to
b7ef3a7
Compare
Merged
github-merge-queue bot
pushed a commit
that referenced
this pull request
Aug 2, 2023
This PR was opened by the [Changesets release](https://github.com/changesets/action) GitHub action. When you're ready to do a release, you can merge this and publish to npm yourself or [setup this action to publish automatically](https://github.com/changesets/action#with-publishing). If you're not ready to do a release yet, that's fine, whenever you add more changesets to main, this PR will be updated. # Releases ## @nomicfoundation/slang@0.9.0 ### Minor Changes - [#540](#540) [`0d04f95`](0d04f95) Thanks [@AntonyBlakey](https://github.com/AntonyBlakey)! - Add a Rust Cursor API and refactor the Rust Visitor API to run on top of it. - [#540](#540) [`0d04f95`](0d04f95) Thanks [@AntonyBlakey](https://github.com/AntonyBlakey)! - Move Visitor et al to node:: namespace, which is where Cursor is. - [#540](#540) [`0d04f95`](0d04f95) Thanks [@AntonyBlakey](https://github.com/AntonyBlakey)! - Rename `range` functions that return a TextRange to `text_range` ### Patch Changes - [#543](#543) [`7a34599`](7a34599) Thanks [@OmarTawfik](https://github.com/OmarTawfik)! - Move `syntax::parser::ProductionKind` to `syntax::nodes` namespace. - [#540](#540) [`0d04f95`](0d04f95) Thanks [@AntonyBlakey](https://github.com/AntonyBlakey)! - Add TokenNode.text to the TS API. - [#540](#540) [`0d04f95`](0d04f95) Thanks [@AntonyBlakey](https://github.com/AntonyBlakey)! - Add first pass of Typescript binding to the Cursor API, but no TS Visitor yet. - [#545](#545) [`e73658a`](e73658a) Thanks [@OmarTawfik](https://github.com/OmarTawfik)! - render EBNF grammar on top of each `ProductionKind`, `RuleKind`, and `TokenKind`. - [#558](#558) [`95bbc50`](95bbc50) Thanks [@OmarTawfik](https://github.com/OmarTawfik)! - Correct versioning for `SourceUnitMember` and `ContractMember` children. ## changelog@0.9.0 ### Minor Changes - [#540](#540) [`0d04f95`](0d04f95) Thanks [@AntonyBlakey](https://github.com/AntonyBlakey)! - Add a Rust Cursor API and refactor the Rust Visitor API to run on top of it. - [#540](#540) [`0d04f95`](0d04f95) Thanks [@AntonyBlakey](https://github.com/AntonyBlakey)! - Move Visitor et al to node:: namespace, which is where Cursor is. - [#540](#540) [`0d04f95`](0d04f95) Thanks [@AntonyBlakey](https://github.com/AntonyBlakey)! - Rename `range` functions that return a TextRange to `text_range` ### Patch Changes - [#543](#543) [`7a34599`](7a34599) Thanks [@OmarTawfik](https://github.com/OmarTawfik)! - Move `syntax::parser::ProductionKind` to `syntax::nodes` namespace. - [#540](#540) [`0d04f95`](0d04f95) Thanks [@AntonyBlakey](https://github.com/AntonyBlakey)! - Add TokenNode.text to the TS API. - [#540](#540) [`0d04f95`](0d04f95) Thanks [@AntonyBlakey](https://github.com/AntonyBlakey)! - Add first pass of Typescript binding to the Cursor API, but no TS Visitor yet. - [#545](#545) [`e73658a`](e73658a) Thanks [@OmarTawfik](https://github.com/OmarTawfik)! - render EBNF grammar on top of each `ProductionKind`, `RuleKind`, and `TokenKind`. - [#558](#558) [`95bbc50`](95bbc50) Thanks [@OmarTawfik](https://github.com/OmarTawfik)! - Correct versioning for `SourceUnitMember` and `ContractMember` children. Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
rollup-smithbm0p
added a commit
to rollup-smithbm0p/slang
that referenced
this pull request
Dec 26, 2025
This PR was opened by the [Changesets release](https://github.com/changesets/action) GitHub action. When you're ready to do a release, you can merge this and publish to npm yourself or [setup this action to publish automatically](https://github.com/changesets/action#with-publishing). If you're not ready to do a release yet, that's fine, whenever you add more changesets to main, this PR will be updated. # Releases ## @nomicfoundation/slang@0.9.0 ### Minor Changes - [#540](NomicFoundation/slang#540) [`0d04f95`](NomicFoundation/slang@0d04f95) Thanks [@AntonyBlakey](https://github.com/AntonyBlakey)! - Add a Rust Cursor API and refactor the Rust Visitor API to run on top of it. - [#540](NomicFoundation/slang#540) [`0d04f95`](NomicFoundation/slang@0d04f95) Thanks [@AntonyBlakey](https://github.com/AntonyBlakey)! - Move Visitor et al to node:: namespace, which is where Cursor is. - [#540](NomicFoundation/slang#540) [`0d04f95`](NomicFoundation/slang@0d04f95) Thanks [@AntonyBlakey](https://github.com/AntonyBlakey)! - Rename `range` functions that return a TextRange to `text_range` ### Patch Changes - [#543](NomicFoundation/slang#543) [`7a34599`](NomicFoundation/slang@7a34599) Thanks [@OmarTawfik](https://github.com/OmarTawfik)! - Move `syntax::parser::ProductionKind` to `syntax::nodes` namespace. - [#540](NomicFoundation/slang#540) [`0d04f95`](NomicFoundation/slang@0d04f95) Thanks [@AntonyBlakey](https://github.com/AntonyBlakey)! - Add TokenNode.text to the TS API. - [#540](NomicFoundation/slang#540) [`0d04f95`](NomicFoundation/slang@0d04f95) Thanks [@AntonyBlakey](https://github.com/AntonyBlakey)! - Add first pass of Typescript binding to the Cursor API, but no TS Visitor yet. - [#545](NomicFoundation/slang#545) [`e73658a`](NomicFoundation/slang@e73658a) Thanks [@OmarTawfik](https://github.com/OmarTawfik)! - render EBNF grammar on top of each `ProductionKind`, `RuleKind`, and `TokenKind`. - [#558](NomicFoundation/slang#558) [`95bbc50`](NomicFoundation/slang@95bbc50) Thanks [@OmarTawfik](https://github.com/OmarTawfik)! - Correct versioning for `SourceUnitMember` and `ContractMember` children. ## changelog@0.9.0 ### Minor Changes - [#540](NomicFoundation/slang#540) [`0d04f95`](NomicFoundation/slang@0d04f95) Thanks [@AntonyBlakey](https://github.com/AntonyBlakey)! - Add a Rust Cursor API and refactor the Rust Visitor API to run on top of it. - [#540](NomicFoundation/slang#540) [`0d04f95`](NomicFoundation/slang@0d04f95) Thanks [@AntonyBlakey](https://github.com/AntonyBlakey)! - Move Visitor et al to node:: namespace, which is where Cursor is. - [#540](NomicFoundation/slang#540) [`0d04f95`](NomicFoundation/slang@0d04f95) Thanks [@AntonyBlakey](https://github.com/AntonyBlakey)! - Rename `range` functions that return a TextRange to `text_range` ### Patch Changes - [#543](NomicFoundation/slang#543) [`7a34599`](NomicFoundation/slang@7a34599) Thanks [@OmarTawfik](https://github.com/OmarTawfik)! - Move `syntax::parser::ProductionKind` to `syntax::nodes` namespace. - [#540](NomicFoundation/slang#540) [`0d04f95`](NomicFoundation/slang@0d04f95) Thanks [@AntonyBlakey](https://github.com/AntonyBlakey)! - Add TokenNode.text to the TS API. - [#540](NomicFoundation/slang#540) [`0d04f95`](NomicFoundation/slang@0d04f95) Thanks [@AntonyBlakey](https://github.com/AntonyBlakey)! - Add first pass of Typescript binding to the Cursor API, but no TS Visitor yet. - [#545](NomicFoundation/slang#545) [`e73658a`](NomicFoundation/slang@e73658a) Thanks [@OmarTawfik](https://github.com/OmarTawfik)! - render EBNF grammar on top of each `ProductionKind`, `RuleKind`, and `TokenKind`. - [#558](NomicFoundation/slang#558) [`95bbc50`](NomicFoundation/slang@95bbc50) Thanks [@OmarTawfik](https://github.com/OmarTawfik)! - Correct versioning for `SourceUnitMember` and `ContractMember` children. Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
No description provided.