Skip to content
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

Merged
merged 2 commits into from
Jul 31, 2024

Conversation

kt3k
Copy link
Member

@kt3k kt3k commented Jul 30, 2024

No description provided.

@kt3k kt3k requested review from ry and iuioiua July 30, 2024 10:52
Copy link

codecov bot commented Jul 30, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.48%. Comparing base (9253dcb) to head (dc705c1).

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.
📢 Have feedback on the report? Share it here.

Copy link
Collaborator

@iuioiua iuioiua left a 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.

@iuioiua
Copy link
Collaborator

iuioiua commented Jul 30, 2024

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.

Copy link
Member

@ry ry left a 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?

@kt3k
Copy link
Member Author

kt3k commented Jul 30, 2024

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 (@experimental jsdoc tag seems translated to unstable label in the doc website.)

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

@kt3k
Copy link
Member Author

kt3k commented Jul 30, 2024

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.

Who are 'we' here? 1 maintainer, 2 maintainers, the core team, or the community? How to check we are highly confident?

@crowlKats
Copy link
Member

@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

@kt3k
Copy link
Member Author

kt3k commented Jul 30, 2024

@crowlKats Ah, ok. Thanks for the input! Then we probably need to do overloads when an API is partially unstable.

@kt3k kt3k merged commit b315e04 into denoland:main Jul 31, 2024
13 checks passed
@kt3k kt3k deleted the chore-clarify-new-feature-policy branch July 31, 2024 03:33
@kt3k kt3k mentioned this pull request Aug 2, 2024
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants