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

Abi class isn't mentioned in changelog #48711

Closed
nex3 opened this issue Mar 31, 2022 · 3 comments
Closed

Abi class isn't mentioned in changelog #48711

nex3 opened this issue Mar 31, 2022 · 3 comments
Assignees
@dcharkes
Labels
area-vm Use area-vm for VM related issues, including code coverage, and the AOT and JIT backends. library-ffi type-documentation A request to add or improve documentation

Comments

@nex3
Copy link
Member

nex3 commented Mar 31, 2022

It looks like dart:ffi added an Abi class in 2.16.0, but it's not mentioned in the changelog. Documenting all new and changing APIs in the changelog is crucial for ensuring that package authors know how to correctly version their packages.
@nex3 nex3 added the type-documentation A request to add or improve documentation label Mar 31, 2022
@lrhn lrhn added area-vm Use area-vm for VM related issues, including code coverage, and the AOT and JIT backends. library-ffi labels Mar 31, 2022
@lrhn
Copy link
Member

lrhn commented Mar 31, 2022 •
edited
Loading

It also seems like every dart:ffi declaration needs a @Since("2.xx") annotation.

You can add the first release to the ffi.dart library itself, as @Since("2.yy") library dart.ffi;, but all later additions should have individual annotations for the version they were introduced in.

@a-siva
Copy link
Contributor

a-siva commented Apr 1, 2022

/cc @dcharkes

@dcharkes dcharkes self-assigned this Apr 5, 2022
@dcharkes
Copy link
Contributor

dcharkes commented Apr 5, 2022

Thanks for reporting.

Will address in:
https://dart-review.googlesource.com/c/sdk/+/240045
https://dart-review.googlesource.com/c/sdk/+/240047

copybara-service bot pushed a commit that referenced this issue Apr 5, 2022
@dcharkes
[vm/ffi] Update dart:ffi entries in changelog
d2e2c95 
Standardize the `dart:ffi` changelog entries header on:
```
### Core Libraries
#### `dart:ffi`
```

Add entries for new additions in last couple of versions. (So far we
mostly only documented breaking changes.)

Bug: #48711
Change-Id: I095c966ad2a1d7123e6543fd19de7af57a573d36
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/240047
Reviewed-by: Michael Thomsen <[email protected]>
Commit-Queue: Daco Harkes <[email protected]>
copybara-service bot pushed a commit that referenced this issue May 17, 2022
@dcharkes @athomas
[vm/ffi] Update dart:ffi entries in changelog
9922de2 
Standardize the `dart:ffi` changelog entries header on:
```
### Core Libraries
#### `dart:ffi`
```

Add entries for new additions in last couple of versions. (So far we
mostly only documented breaking changes.)

Bug: #48711
Change-Id: I095c966ad2a1d7123e6543fd19de7af57a573d36
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/240047
Reviewed-by: Michael Thomsen <[email protected]>
Commit-Queue: Daco Harkes <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@dcharkes dcharkes

Labels
area-vm Use area-vm for VM related issues, including code coverage, and the AOT and JIT backends. library-ffi type-documentation A request to add or improve documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@nex3 @dcharkes @lrhn @a-siva