Repository navigation
docs(emitter-framework): Add JSDoc for TypeScript components and transformations [skip chg] - #12220
Closed
Timothee Guerin (timotheeguerin) wants to merge 3 commits into
Closed
Timothee Guerin (timotheeguerin) wants to merge 3 commits into
Timothee Guerin (timotheeguerin) wants to merge 3 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 preserve behavior and signatures, with no unresolved review issues.
0 open findings
What changed in this PR
Adds JSDoc for emitter-framework’s TypeScript APIs as part of #12228, without changing runtime behavior or API signatures.
Changes:
- Clarifies operation-derived signatures, parameter ordering, and error filtering.
- Documents declaration composition and reference versus inline rendering.
- Explains transformation naming, helper dependencies, and serializer input behavior.
| File | Description |
|---|---|
| packages/emitter-framework/src/typescript/utils/operation.ts | Documents return filtering and parameter descriptors. |
| packages/emitter-framework/src/typescript/components/union/expression.tsx | Explains union and enum alternatives. |
| packages/emitter-framework/src/typescript/components/union/declaration.tsx | Documents union alias options. |
| packages/emitter-framework/src/typescript/components/type-transform.tsx | Clarifies conversion directions and helper dependencies. |
| packages/emitter-framework/src/typescript/components/type-expression.tsx | Explains reference and inline rendering. |
| packages/emitter-framework/src/typescript/components/type-declaration.tsx | Documents declaration selection. |
| packages/emitter-framework/src/typescript/components/static-serializers.tsx | Describes runtime helpers and null/falsy handling. |
| packages/emitter-framework/src/typescript/components/interface-method.tsx | Clarifies operation-backed method options. |
| packages/emitter-framework/src/typescript/components/interface-member.tsx | Documents property and method rendering. |
| packages/emitter-framework/src/typescript/components/interface-declaration.tsx | Explains interface composition and defaults. |
| packages/emitter-framework/src/typescript/components/function-type.tsx | Clarifies signature defaults and parameter ordering. |
| packages/emitter-framework/src/typescript/components/function-expression.tsx | Clarifies signature defaults and parameter ordering. |
| packages/emitter-framework/src/typescript/components/function-declaration.tsx | Documents operation-backed declarations and parameter lists. |
| packages/emitter-framework/src/typescript/components/class-method.tsx | Explains method signatures and return annotations. |
| packages/emitter-framework/src/typescript/components/arrow-function.tsx | Clarifies operation defaults and parameter ordering. |
| packages/emitter-framework/src/typescript/components/array-expression.tsx | Distinguishes array type expressions from values. |
🧠 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
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](#12213), [12220](#12220), [12223](#12223), [12226](#12226), [12227](#12227). 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.
TypeScript emitter authors need to know which signatures come from TypeSpec, how explicit parameters are combined, and which conversion helpers must be rendered before referencing them.
Document component composition, error-return filtering, reference versus inline rendering, and application/transport naming. Clarify that serializer components emit runtime helpers, including their null/falsy input behavior. No runtime or type changes.
Tracked in #12228.