Enhance documentation for @typeChangedFrom and @returnTypeChangedFrom decorators#9563
Draft
Enhance documentation for @typeChangedFrom and @returnTypeChangedFrom decorators#9563
Conversation
…ypeChangedFrom Co-authored-by: markcowl <1054056+markcowl@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Update JSDoc comments for versioning decorators
Enhance documentation for @typeChangedFrom and @returnTypeChangedFrom decorators
Feb 3, 2026
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.
The versioning decorators
@typeChangedFromand@returnTypeChangedFromhad minimal JSDoc comments ("Identifies when the target type changed"), insufficient for LLMs and developers to understand their behavior and correct usage.Changes
Enhanced JSDoc comments in
packages/versioning/lib/decorators.tsp:string→int32)Regenerated reference docs at
website/src/content/docs/docs/libraries/versioning/reference/decorators.mdExample
Before, documentation simply stated "The version that the target type changed in." Now:
With clear explanation that the property uses
stringbefore v2 andint32from v2 onwards.Original prompt
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.