Repository navigation
docs(emitter-framework): Add JSDoc for Python emitter framework type and callable components [skip chg] - #12226
Closed
Timothee Guerin (timotheeguerin) wants to merge 2 commits into
Conversation
microsoft-github-policy-service
Bot
added
the
emitter-framework
Timothee Guerin (timotheeguerin)
changed the title
commit: |
29 of 30 tasks
Contributor
|
❌ There is undocummented changes. Run The following packages have changes but are not documented.
Show changes |
|
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 API signatures, with no unresolved review findings.
0 open findings
What changed in this PR
Documents the Python emitter-framework contracts as part of the public API JSDoc improvements tracked in #12228. Runtime behavior and API signatures remain unchanged.
Changes:
- Clarifies annotations, references, declaration selection, and enum values.
- Explains callable parameter ordering, defaults, and overrides.
- Documents importable built-ins and documentation normalization.
| File | Description |
|---|---|
packages/emitter-framework/src/python/utils/operation.ts |
Documents return filtering and parameter ordering. |
packages/emitter-framework/src/python/components/type-expression/type-expression.tsx |
Clarifies annotations and reference limitations. |
packages/emitter-framework/src/python/components/type-declaration/type-declaration.tsx |
Documents declaration dispatch. |
packages/emitter-framework/src/python/components/type-alias-declaration/type-alias-declaration.tsx |
Explains alias and template-model handling. |
packages/emitter-framework/src/python/components/record-expression/record-expression.tsx |
Distinguishes dictionary annotations from values. |
packages/emitter-framework/src/python/components/protocol-declaration/protocol-declaration.tsx |
Documents protocol generation and documentation forwarding. |
packages/emitter-framework/src/python/components/protocol-declaration/callable-parameters.tsx |
Clarifies flat parameter descriptors. |
packages/emitter-framework/src/python/components/function-declaration/function-declaration.tsx |
Explains signature overrides and positional parameters. |
packages/emitter-framework/src/python/components/enum-declaration/enum-member.tsx |
Documents member values and metadata. |
packages/emitter-framework/src/python/components/enum-declaration/enum-declaration.tsx |
Explains enum bases and JSON values. |
packages/emitter-framework/src/python/components/doc-element/doc-element.tsx |
Documents normalized documentation inputs. |
packages/emitter-framework/src/python/components/array-expression/array-expression.tsx |
Clarifies list annotation output. |
packages/emitter-framework/src/python/builtins.ts |
Documents importable Python symbols. |
🧠 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.
Python emitter authors need to distinguish annotations from value expressions, understand enum wire values, and choose between function, alias, and callback-protocol output.
Document those contracts together with importable built-ins, documentation normalization, reference behavior, and parameter ordering/defaults. Clarify the noReference limitation for named models and when extra parameters remain positional. Documentation only.
Tracked in #12228.