Repository navigation
docs(compiler): Add JSDoc for semantic type variants [skip chg] - #12274
Closed
Timothee Guerin (timotheeguerin) wants to merge 1 commit into
Closed
Timothee Guerin (timotheeguerin) wants to merge 1 commit into
Timothee Guerin (timotheeguerin) wants to merge 1 commit into
Conversation
microsoft-github-policy-service
Bot
added
the
compiler:core
29 of 30 tasks
commit: |
|
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 APIs and behavior, with no unresolved findings.
0 open findings
What changed in this PR
Adds JSDoc for compiler semantic types as part of the public API documentation improvements tracked in #12228.
Changes:
- Clarifies declaration ownership, scalar constructors, and callable parameter contracts.
- Documents literal precision, template spans, and union alternatives.
- Preserves runtime behavior, API signatures, and experimental guidance.
| File | Description |
|---|---|
| packages/compiler/src/core/types.ts | Adds JSDoc describing semantic type variants and their members. |
🧠 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
…12245) Consumers of the compiler's semantic model need to understand how types, template instances, model properties, and runtime values relate without reading the checker implementation. Document the public type foundations, semantic variants, and value contracts together, including optional state, ownership, and relationships. Existing APIs and behavior are unchanged. Consolidates [12257](#12257), [12274](#12274). 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 consumers need to navigate semantic declarations without mistaking scalar constructors for values, operation signatures for functions, or anonymous union alternatives for named variants.
Adds JSDoc for scalars, enums, operations, interfaces, namespaces, literal and template types, unions, and callable parameter contracts. Explains ownership, inherited constructors, numeric precision, source-order spans, and union-expression distinctions while preserving existing experimental guidance and all signatures.
Tracked in #12228.