Skip to content

Commit

Permalink
WorkerManager: Correct javadoc for "stop". (apache#17279)
Browse files Browse the repository at this point in the history
The javadoc had a factual error: Dart's implementation does not in
fact always return immediately.
  • Loading branch information
gianm authored Oct 8, 2024
1 parent 0a279e6 commit 152330c
Showing 1 changed file with 5 additions and 3 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -85,9 +85,11 @@ public interface WorkerManager
/**
* Stop all workers.
*
* The task-based implementation blocks until all tasks exit. Dart's implementation queues workers for stopping in
* the background, and returns immediately. Either way, this method returns quietly, no matter whether there was an
* exception associated with the future from {@link #start()} or not.
* The task-based implementation blocks until all tasks exit. Dart's implementation sends stop commands and waits
* for workers to exit if "interrupt" is true, otherwise it returns immediately.
*
* Either way, this method returns quietly, no matter whether there was an exception associated with the future
* from {@link #start()} or not.
*
* @param interrupt whether to interrupt currently-running work
*/
Expand Down

0 comments on commit 152330c

Please sign in to comment.