Skip to content

docs(compiler): Add JSDoc for semantic types and values [skip chg] - #12245

Merged
Timothee Guerin (timotheeguerin) merged 6 commits into
microsoft:mainfrom
timotheeguerin:docs/jsdoc-compiler-type-model-foundations
Oct 16, 2026
Merged

Timothee Guerin (timotheeguerin) merged 6 commits into
microsoft:mainfrom
timotheeguerin:docs/jsdoc-compiler-type-model-foundations

Conversation

@timotheeguerin

@timotheeguerin Timothee Guerin (timotheeguerin) commented Oct 15, 2026 •

Copy link
Copy Markdown
Member

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, 12274.

Tracked in #12228.

@microsoft-github-policy-service microsoft-github-policy-service Bot added the compiler:core Issues for @typespec/compiler label Oct 15, 2026
@pkg-pr-new

pkg-pr-new Bot commented Oct 15, 2026 •

Copy link
Copy Markdown

Open in StackBlitz

npm i https://pkg.pr.new/@typespec/compiler@12245

commit: c28fffc

@azure-sdk-automation

azure-sdk-automation Bot commented Oct 15, 2026 •

Copy link
Copy Markdown

You can try these changes here

🛝 Playground 🌐 Website 🛝 VSCode Extension

@timotheeguerin

Copy link
Copy Markdown
Member Author

/azp run typespec - ci

@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines:
Successfully started running 1 pipeline(s).

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

Note

This error may be related to your runner configuration. You can now configure runners for Copilot code review separately from Copilot cloud agent by creating a copilot-code-review.yml file with your setup steps. Read the docs for details.

Copilot AI balanced review requested due to automatic review settings October 16, 2026 14:11
@timotheeguerin Timothee Guerin (timotheeguerin) changed the title docs(compiler): Add JSDoc for type foundations and model graph [skip chg] docs(compiler): Add JSDoc for semantic types and values [skip chg] Oct 16, 2026

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approval recommended

The documentation-only changes preserve existing contracts and behavior, with no unresolved findings.

0 open findings

🧠 Review effort: Balanced

@timotheeguerin
Timothee Guerin (timotheeguerin) merged commit b5030c6 into microsoft:main Oct 16, 2026
31 of 33 checks passed
@timotheeguerin
Timothee Guerin (timotheeguerin) deleted the docs/jsdoc-compiler-type-model-foundations branch October 16, 2026 16:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

compiler:core Issues for @typespec/compiler

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants