Repository navigation
docs(emitter-framework): Add JSDoc for public APIs [skip chg] - #12209
Merged
Timothee Guerin (timotheeguerin) merged 15 commits intoOct 16, 2026
Merged
Timothee Guerin (timotheeguerin) merged 15 commits into
Timothee Guerin (timotheeguerin) merged 15 commits into
Conversation
microsoft-github-policy-service
Bot
added
the
emitter-framework
commit: |
Contributor
|
❌ There is undocummented changes. Run The following packages have changes but are not documented.
Show changes |
Timothee Guerin (timotheeguerin)
changed the title
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:45
Timothee Guerin (timotheeguerin)
requested review from
catalinaperalta,
iscai-msft,
Laurent Mazuel (lmazuel) and
Mark Cowlishaw (markcowl)
as code owners
October 16, 2026 13:45
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
The documentation-only changes have no identified correctness issues and preserve runtime behavior and API signatures.
0 open findings
What changed in this PR
Adds JSDoc to emitter-framework APIs as part of #12228, clarifying contracts for emitter authors without changing runtime behavior or API signatures.
Changes:
- Documents output rendering and persistence.
- Explains context requirements, lazy typekit initialization, and naming defaults.
- Clarifies graph views and declaration/reference override precedence.
| File | Description |
|---|---|
| packages/emitter-framework/src/core/write-output.ts | Documents rendering and file-writing behavior. |
| packages/emitter-framework/src/core/transport-name-policy.ts | Distinguishes wire names from application identifiers. |
| packages/emitter-framework/src/core/scc-set.ts | Describes graph groups and traversal options. |
| packages/emitter-framework/src/core/context/tsp-context.ts | Explains provider requirements and lazy typekit initialization. |
| packages/emitter-framework/src/core/context/name-policy-context.ts | Documents naming-policy defaults and fallback. |
| packages/emitter-framework/src/core/components/overrides/config.ts | Explains registration precedence and scalar inheritance. |
| packages/emitter-framework/src/core/components/overrides/component-overrides.tsx | Documents override inputs, composition, and provider scope. |
| packages/emitter-framework/src/core/components/output.tsx | Describes output context and forwarded options. |
🧠 Review effort: Balanced
💡 Configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Timothee Guerin (timotheeguerin)
changed the title
This was referenced Oct 16, 2026
Closed
Closed
Timothee Guerin (timotheeguerin)
merged commit Oct 16, 2026
be23aff
into
microsoft:main
31 of 33 checks passed
Timothee Guerin (timotheeguerin)
deleted the
docs/jsdoc-framework-core
branch
October 16, 2026 16:18
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.
Emitter authors need usable contracts across contexts, language components, transformations, and testing helpers, not just component names and TypeScript signatures.
Document the public emitter framework together, including its C#, TypeScript, and Python components. Explain defaults, supported input shapes, transformation scope, and error filtering without changing generated output or APIs.
Consolidates 12213, 12220, 12223, 12226, 12227.
Tracked in #12228.