Add documentation comments to config.yml#89
Open
Morriar wants to merge 1 commit into
Open
Conversation
Morriar
force-pushed
the
document-config-nodes
branch
2 times, most recently
from
0fcb209 to
71a5840
Compare
Add `comment:` fields to all 77 node definitions in config.yml, following Prism's documentation pattern with prose descriptions, RBS code examples, and caret location markers.
Morriar
force-pushed
the
document-config-nodes
branch
from
71a5840 to
736e449
Compare
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
1 participant
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.
Summary
comment:fields to all 77 AST node types, their fields, and all 6 enums inconfig.yml^^^^location markerscomment:keys are safely ignored by both the Ruby template engine (templates/template.rb) and the Rust serde deserializer (build.rs), so no generated code changesCloses https://github.com/Shopify/team-ruby-dx/issues/1388