Skip to content

Job.cancel() should not return a Boolean, but Unit #713

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
Closed
elizarov opened this issue Oct 16, 2018 · 2 comments
Closed

Job.cancel() should not return a Boolean, but Unit #713

elizarov opened this issue Oct 16, 2018 · 2 comments
Assignees
@qwwdfsad

Comments

@elizarov
Copy link
Contributor

Currently, Job.cancel() result documentation is inconsistent with the actual return value for Job() instances. Moreover, it is unclear how boolean result of Job.cancel() could be used, that is, we don't see any compelling use-case on the use of that boolean value that could guide the logic that this boolean value shall have. So, the proposal is change Job.cancel() so that it returns Unit.
@Dico200
Copy link

Dico200 commented Oct 16, 2018

Is this something you might consider to change before 1.0 release?

@elizarov
Copy link
Contributor Author

Likely, yes.

qwwdfsad added a commit that referenced this issue Oct 17, 2018
@qwwdfsad
Job.cancel and ReceiveChannel.cancel now return unit instead of boolean
37a91e5 
Fixes #713
qwwdfsad added a commit that referenced this issue Oct 17, 2018
@qwwdfsad
Deprecate Job.cancel(cause) and ReceiveChannel.cancel(cause), return …
e654dc1 
…Unit from cancel without cause

Fixes #713
Fixes #481
@qwwdfsad qwwdfsad mentioned this issue Oct 17, 2018
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@qwwdfsad qwwdfsad

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@elizarov @qwwdfsad @Dico200