Repository navigation
docs(mutator-framework): Add JSDoc for public APIs [skip chg] - #12211
Merged
Timothee Guerin (timotheeguerin) merged 11 commits intoOct 16, 2026
Merged
Timothee Guerin (timotheeguerin) merged 11 commits into
Timothee Guerin (timotheeguerin) merged 11 commits into
Conversation
commit: |
Contributor
|
All changed packages have been 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 changes are documentation-only, with one non-blocking clarification about constructor arguments.
1 open finding
What changed in this PR
Documents mutation-engine contracts for custom strategy authors as part of #12228, without changing APIs or runtime behavior.
Changes:
- Explains strategy identity, caching, and deferred connections.
- Documents single-node strategies and unused option inputs.
- Adds an internal changelog entry.
| File | Description |
|---|---|
| packages/mutator-framework/src/mutation/simple-mutation-engine.ts | Documents single-node strategies and options. |
| packages/mutator-framework/src/mutation/mutation.ts | Explains strategy lifecycle and cache metadata. |
| packages/mutator-framework/src/mutation/mutation-engine.ts | Documents registries, contexts, caching, and connections. |
| .chronus/changes/docs-jsdoc-mutator-engine-2026-9-15-11-57-44.md | Records the documentation update. |
🧠 Review effort: Balanced
💡 Configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
|
|
||
| /** | ||
| * Mutation inputs together with the selected cache identity. | ||
| * Describes the combined context; constructors receive these values positionally. |
Timothee Guerin (timotheeguerin)
changed the title
This was referenced Oct 16, 2026
Timothee Guerin (timotheeguerin)
merged commit Oct 16, 2026
673cab7
into
microsoft:main
31 of 33 checks passed
Timothee Guerin (timotheeguerin)
deleted the
docs/jsdoc-mutator-engine
branch
October 16, 2026 16:19
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.
Mutation authors need to distinguish registered graph state, replacement results, traversal callbacks, and concrete mutation helpers without inferring their lifecycle from implementation.
Document the public mutation framework together, from engine and graph contracts through model/operation, scalar/enum/union, value, and tuple mutations. Clarify ownership and replacement semantics without changing mutation behavior.
Consolidates 12216, 12219, 12222.
Tracked in #12228.