Repository navigation
docs(emitter-framework): Add JSDoc for Python classes and Pydantic components [skip chg] - #12223
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: |
Timothee Guerin (timotheeguerin)
changed the title
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 signatures, with no unresolved review findings.
0 open findings
What changed in this PR
Adds JSDoc for emitter-framework’s Python class and Pydantic components, supporting the public API documentation work tracked in #12228. Runtime behavior, public signatures, and generated Python remain unchanged.
Changes:
- Documents class inputs, member overrides, and method-context precedence.
- Clarifies Pydantic configuration, decorators, and wrapper behavior.
| File | Description |
|---|---|
| packages/emitter-framework/src/python/components/class-declaration/pydantic-decorators.tsx | Documents validator and serializer options. |
| packages/emitter-framework/src/python/components/class-declaration/pydantic-class-declaration.tsx | Clarifies configuration precedence and class wrappers. |
| packages/emitter-framework/src/python/components/class-declaration/primitive-initializer.tsx | Describes initializer inputs. |
| packages/emitter-framework/src/python/components/class-declaration/class-method.tsx | Documents method defaults, overrides, and decorator ordering. |
| packages/emitter-framework/src/python/components/class-declaration/class-member.tsx | Explains field and method overrides. |
| packages/emitter-framework/src/python/components/class-declaration/class-declaration.tsx | Describes class sources and generation options. |
| packages/emitter-framework/src/python/components/class-declaration/class-body.tsx | Clarifies generated members and appended content. |
| packages/emitter-framework/src/python/components/class-declaration/class-bases.tsx | Documents base-class ordering. |
🧠 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 understand how generated fields, custom members, method defaults, and Pydantic configuration compose without accidentally changing inheritance or validation behavior.
Clarify class/member inputs, method-context precedence and decorator ordering, ConfigDict keyword emission and omission, raw configuration precedence, and the BaseSettings/RootModel wrappers. Documentation only; public signatures and generated Python remain unchanged.
Tracked in #12228.