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.

Sign up for GitHub

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

Jump to bottom

Should we be using the internal Since annotation for new features? #37127

Closed
kevmoo opened this issue May 30, 2019 · 9 comments
Closed

Should we be using the internal Since annotation for new features? #37127

kevmoo opened this issue May 30, 2019 · 9 comments
Labels
area-analyzer Use area-analyzer for Dart analyzer issues, including the analysis server and code completion. area-core-library SDK core library issues (core, async, ...); use area-vm or area-web for platform specific libraries. area-vm Use area-vm for VM related issues, including code coverage, FFI, and the AOT and JIT backends. type-question A question about expected behavior or functionality

Comments

@kevmoo
Copy link
Member

kevmoo commented May 30, 2019

sdk/sdk/lib/internal/internal.dart

Lines 200 to 204 in a25f927

@Since("2.2")
class Since {
final String version;
const Since(this.version);
}

aa2ce7c just landed HttpClientResponse. compressionState and HttpClientResponseCompressionState

Should these be annotated w/ Since? @lrhn @turnidge @zanderso

Should we look to get Analyzer to support Since so it's useful for end users? @stereotype441 @devoncarew @bwilkerson
@kevmoo kevmoo added area-vm Use area-vm for VM related issues, including code coverage, FFI, and the AOT and JIT backends. area-core-library SDK core library issues (core, async, ...); use area-vm or area-web for platform specific libraries. area-analyzer Use area-analyzer for Dart analyzer issues, including the analysis server and code completion. type-question A question about expected behavior or functionality labels May 30, 2019
@kevmoo
Copy link
Member Author

kevmoo commented May 30, 2019 •
edited

Ditto for

@kevmoo kevmoo changed the title Should we be using Since? Should we be using the internal Since annotation for new features? May 30, 2019
@kevmoo
Copy link
Member Author

kevmoo commented May 30, 2019

CC @mit-mit

@kevmoo
Copy link
Member Author

kevmoo commented May 31, 2019

Ditto for dart:isolate debug name - ac2c934

@zanderso
Copy link
Member

@turnidge's input would surely be invaluable, but @tvolkert is probably the more correct Todd in this case.

@lrhn
Copy link
Member

lrhn commented Jun 1, 2019 •
edited

True, we should use it. If for nothing else, then for documentation.

For breaking changes, it's not always possible to find a place to put the annotation, but incremental changes should be doable.

dart-bot pushed a commit that referenced this issue Jun 2, 2019
@tvolkert
Annotate new APIs with @SInCE
ebbfc7d 
* HttpClientResponse.compressionState
* HttpClientResponseCompressionState

Bug: #37127
Change-Id: I1823156bc3545b87293dfa61471e8d5c97013cdc
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/104483
Commit-Queue: Kevin Moore <kevmoo@google.com>
Reviewed-by: Kevin Moore <kevmoo@google.com>
@tvolkert
Copy link
Contributor

tvolkert commented Jun 3, 2019

HttpClientResponse.compressionState and HttpClientResponseCompressionState are done as of ebbfc7d

@lrhn
Copy link
Member

lrhn commented Jun 4, 2019

For the record, new features should be releases in minor version increments, so the next release where new features are released will be 2.4.0.

If we release a 2.3.2, it will be a patch/bug-fix release cherry-picked from head, and it will most likely not contain any of the new features.
So, for not-yet-released features, the annotations should be @Since("2.4.0").

@devoncarew
Copy link
Member

I think the sdk version doesn't follow strict semver, and won't always rev the minor version even when there are api additions (reving the sdk version is more of a product decision than a semver one).

dart-bot pushed a commit that referenced this issue Jun 6, 2019
@lrhn
Add @Since annotations to some recent and future features.
a8a0aff 
Addresses some parts of #37127

Bug: http://dartbug.com/37127
Change-Id: Ia3a98e5764a16529331b2ba5613096d27061cab0
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/104763
Commit-Queue: Lasse R.H. Nielsen <lrn@google.com>
Reviewed-by: Todd Volkert <tvolkert@google.com>
Reviewed-by: Jonas Termansen <sortie@google.com>
@lrhn
Copy link
Member

lrhn commented Oct 12, 2020

We should generally use Since on new features.

@lrhn lrhn closed this as completed Oct 12, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
area-analyzer Use area-analyzer for Dart analyzer issues, including the analysis server and code completion. area-core-library SDK core library issues (core, async, ...); use area-vm or area-web for platform specific libraries. area-vm Use area-vm for VM related issues, including code coverage, FFI, and the AOT and JIT backends. type-question A question about expected behavior or functionality
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
5 participants
@kevmoo @devoncarew @lrhn @zanderso @tvolkert