-
Notifications
You must be signed in to change notification settings - Fork 603
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
chore: clarify the policy about new features #5581
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #5581 +/- ##
=======================================
Coverage 96.48% 96.48%
=======================================
Files 465 465
Lines 37759 37759
Branches 5579 5579
=======================================
Hits 36432 36432
Misses 1285 1285
Partials 42 42 ☔ View full report in Codecov by Sentry. |
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.
I think it's good that this doesn't include timelines. LGTM.
I think we can make exceptions for APIs that we are highly confident will not yield unexpected behavior. E.g. #5573 is fine to add as stable. |
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.
Do we have a mechanism to mark APIs as unstable? Is there a special jsdoc markup?
Yes for symbols https://jsr.io/@std/cli/doc/~/Spinner ( But I'm not sure about the way to mark specific parameter in function as unstable. (which is necessary for the case like #5573 ) cc @crowlKats |
Who are 'we' here? 1 maintainer, 2 maintainers, the core team, or the community? How to check |
@kt3k sadly both jsdoc and tsdoc dont have a way to mark unstable/experimental parameters. the only way i can think of is having overloads, where the overload with an unstable parameter is marked as unstable |
@crowlKats Ah, ok. Thanks for the input! Then we probably need to do overloads when an API is partially unstable. |
No description provided.