-
-
Notifications
You must be signed in to change notification settings - Fork 6
Rename private JSDoc typedefs in migrated modules #1462
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
4c79e40
dd2c3c4
737f3c7
8dac64c
a5715a8
e0b2b44
4013590
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -23,7 +23,7 @@ import { | |
| /** | ||
| * @template T | ||
| * @typedef {Result<T> | | ||
| * Concat<T> | | ||
| * Concat<T> | | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Keeping Useful? React with 👍 / 👎.
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. No, |
||
| * readonly T[] | ||
| * } NotLazy | ||
| */ | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
When a typedef was explicitly exported from the pre-migration
.f.ts, consumers were entitled to import it; changing it to an_name makes that API private under this README's own convention. This guidance presents such reclassification as an ordinary per-typedef choice without requiring breaking-change treatment, so a future migration could silently remove supported imports. Qualify the former-export case as a breaking API change that needs the corresponding changelog entry and importer updates.AGENTS.md reference: AGENTS.md:L965-L973
Useful? React with 👍 / 👎.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Moving to
.mjsis a breaking change anyway, so we have an opportunity to fix what was broken before. We are only discussing future changes in.mjstypes.