Skip to content

docs(asset-emitter): Add JSDoc for builders and deferred references [skip chg] - #12221

Closed
Timothee Guerin (timotheeguerin) wants to merge 2 commits into
microsoft:mainfrom
timotheeguerin:docs/jsdoc-asset-builders
Closed

Timothee Guerin (timotheeguerin) wants to merge 2 commits into
microsoft:mainfrom
timotheeguerin:docs/jsdoc-asset-builders

Conversation

@timotheeguerin

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

Copy link
Copy Markdown
Member

Emitter authors composing circular output need to know when placeholders update existing values, whether callbacks replay resolved values, and how mutable builders unwrap emit results. Inheriting Array.push documentation also obscures ArrayBuilder’s argument-count return value.

Explain builder mutation and copying, placeholder subscription timing, no-emit and circular-result handling, and reference-cycle rotation and iteration. Preserve the deprecated setter guidance and inherited cycle string description without changing behavior.

Tracked in #12228.

@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/asset-emitter@12221

commit: 268f0c3

@github-actions

Copy link
Copy Markdown
Contributor

❌ There is undocummented changes. Run chronus add to add a changeset or click here.

The following packages have changes but are not documented.

  • ❌@typespec/asset-emitter
Show changes

@timotheeguerin Timothee Guerin (timotheeguerin) changed the title Document asset-emitter builders and deferred references docs(asset-emitter): Add JSDoc for builders and deferred references [skip chg] Oct 15, 2026
@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

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.

@timotheeguerin

Copy link
Copy Markdown
Member Author

Consolidated into #12208 to keep one PR per package and at most five compiler PRs. The reviewed changes and corrections are preserved there.

Tracked in #12228.

Timothee Guerin (timotheeguerin) added a commit that referenced this pull request Oct 16, 2026
Emitter authors currently have to read traversal internals to understand
output scopes, callback lifecycles, context propagation, and deferred
references.

Document the complete public asset-emitter API together, including
declaration naming, circular-reference handling, mutable builders,
placeholder subscriptions, serialization, and writing. Existing APIs and
output behavior are unchanged.

Consolidates [12217](#12217),
[12221](#12221).

Tracked in #12228.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants