Repository navigation
docs(compiler): Add JSDoc for reference and function AST [skip chg] - #12279
Closed
Timothee Guerin (timotheeguerin) wants to merge 2 commits into
Closed
Timothee Guerin (timotheeguerin) wants to merge 2 commits into
Timothee Guerin (timotheeguerin) wants to merge 2 commits into
Conversation
microsoft-github-policy-service
Bot
added
the
compiler:core
commit: |
29 of 30 tasks
|
You can try these changes here
|
Timothee Guerin (timotheeguerin)
marked this pull request as ready for review
October 16, 2026 13:44
Timothee Guerin (timotheeguerin)
requested review from
catalinaperalta,
iscai-msft,
Laurent Mazuel (lmazuel) and
Mark Cowlishaw (markcowl)
as code owners
October 16, 2026 13:44
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
The documentation-only changes preserve existing behavior and have no unresolved review findings.
0 open findings
What changed in this PR
Adds compiler AST JSDoc as part of the public API documentation effort tracked in #12228, without changing signatures or runtime behavior.
Changes:
- Clarifies identifier spelling, references, and explicit template arguments.
- Documents function signatures, calls, modifiers, and contextual identifier roles.
| File | Description |
|---|---|
packages/compiler/src/core/types.ts |
Adds documentation for reference, template, function, and related AST contracts. |
🧠 Review effort: Balanced
💡 Configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Member
Author
Timothee Guerin (timotheeguerin)
added a commit
that referenced
this pull request
Oct 16, 2026
…12244) AST consumers need a coherent reference for syntax kinds, source locations, symbols, declarations, and expressions rather than isolated undocumented node fields. Document the public syntax and source contracts together, including parser limitations, node relationships, optional locations, and documentation-comment structure. No parser behavior or API signatures change. Consolidates [12251](#12251), [12247](#12247), [12259](#12259), [12270](#12270), [12276](#12276), [12279](#12279). Tracked in #12228.
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
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.
Compiler tooling needs the original spelling versus decoded identifier name, explicit template arguments versus defaults, and declaration signatures versus call targets. Document reference, template, and function syntax alongside modifier invariants, omitted constraints, intrinsic keywords, and contextual identifier roles. Public signatures, source tokens, and compiler behavior remain unchanged.
Tracked in #12228.