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

Please, clarify description for Isolate.kill(): default value for parameter priority #28132

Closed
alsemenov opened this issue Dec 16, 2016 · 1 comment
Closed

Please, clarify description for Isolate.kill(): default value for parameter priority #28132

alsemenov opened this issue Dec 16, 2016 · 1 comment
Assignees
@floitschG
Labels
area-core-library SDK core library issues (core, async, ...); use area-vm or area-web for platform specific libraries. library-isolate type-documentation A request to add or improve documentation

Comments

@alsemenov
Copy link
Contributor

The description for method Isolate.kill() reads:

void kill({
int priority: BEFORE_NEXT_EVENT
})
Requests the isolate to shut down.

The isolate is requested to terminate itself. The priority argument specifies when this must happen.

The priority must be one of IMMEDIATE or BEFORE_NEXT_EVENT. The shutdown is performed at different times depending on the priority:

Since parameter priority is optional, it may be omitted. The method's behavior is not clear in this case. Please, clarify.
@lrhn
Copy link
Member

lrhn commented Dec 16, 2016

The parameter has a documented default value of Isolate.BEFORE_NEXT_EVENT, so if the parameter is omitted, it will use that value.
We usually don't repeat that information in the documentation - but perhaps we should.

@lrhn lrhn added area-core-library SDK core library issues (core, async, ...); use area-vm or area-web for platform specific libraries. library-isolate type-documentation A request to add or improve documentation labels Dec 16, 2016
@floitschG floitschG self-assigned this Dec 20, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@floitschG floitschG

Labels
area-core-library SDK core library issues (core, async, ...); use area-vm or area-web for platform specific libraries. library-isolate type-documentation A request to add or improve documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@alsemenov @lrhn @floitschG