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

[vm/ffi] Improve syzeOf() documentation #44886

Open
sgrekhov opened this issue Feb 8, 2021 · 1 comment
Open

[vm/ffi] Improve syzeOf() documentation #44886

sgrekhov opened this issue Feb 8, 2021 · 1 comment
Assignees
@dcharkes
Labels
area-vm Use area-vm for VM related issues, including code coverage, FFI, and the AOT and JIT backends. library-ffi type-documentation A request to add or improve documentation

Comments

@sgrekhov
Copy link
Contributor

sgrekhov commented Feb 8, 2021 •
edited

sizeOf() documentation reads

int sizeOf < T extends NativeType >()
Number of bytes used by native type T.

Includes padding and alignment of structs.

Please add "Throws an exception if T is unsized"
@sgrekhov sgrekhov added area-documentation Prefer using 'type-documentation' and a specific area label. library-ffi labels Feb 8, 2021
@sgrekhov
Copy link
Contributor Author

sgrekhov commented Feb 8, 2021

It also produces an exception for sizeOf< NativeType >() which is not @unsized. Documentation should inform about it as well

@dcharkes dcharkes added the area-vm Use area-vm for VM related issues, including code coverage, FFI, and the AOT and JIT backends. label Feb 8, 2021
@dcharkes dcharkes self-assigned this Feb 8, 2021
@devoncarew devoncarew added type-documentation A request to add or improve documentation and removed area-documentation Prefer using 'type-documentation' and a specific area label. labels Apr 16, 2024
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, FFI, 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
3 participants
@devoncarew @dcharkes @sgrekhov