@@ -74,7 +74,7 @@ defmodule Task.Supervisor do
74
74
75
75
This function could also receive `:restart` and `:shutdown` as options
76
76
but those two options have been deprecated and it is now preferred to
77
- give them directly to `start_child` and `async` .
77
+ give them directly to `start_child`.
78
78
"""
79
79
@ spec start_link ( [ option ] ) :: Supervisor . on_start ( )
80
80
def start_link ( options \\ [ ] ) do
@@ -105,7 +105,7 @@ defmodule Task.Supervisor do
105
105
106
106
The `supervisor` must be a reference as defined in `Supervisor`.
107
107
The task will still be linked to the caller, see `Task.async/3` for
108
- more information and `async_nolink/2 ` for a non-linked variant.
108
+ more information and `async_nolink/3 ` for a non-linked variant.
109
109
110
110
Raises an error if `supervisor` has reached the maximum number of
111
111
children.
@@ -126,7 +126,7 @@ defmodule Task.Supervisor do
126
126
127
127
The `supervisor` must be a reference as defined in `Supervisor`.
128
128
The task will still be linked to the caller, see `Task.async/3` for
129
- more information and `async_nolink/2 ` for a non-linked variant.
129
+ more information and `async_nolink/3 ` for a non-linked variant.
130
130
131
131
Raises an error if `supervisor` has reached the maximum number of
132
132
children.
@@ -235,7 +235,7 @@ defmodule Task.Supervisor do
235
235
children.
236
236
237
237
Note this function requires the task supervisor to have `:temporary`
238
- as the `:restart` option (the default), as `async_nolink/4 ` keeps a
238
+ as the `:restart` option (the default), as `async_nolink/5 ` keeps a
239
239
direct reference to the task which is lost if the task is restarted.
240
240
"""
241
241
@ spec async_nolink ( Supervisor . supervisor ( ) , module , atom , [ term ] , Keyword . t ( ) ) :: Task . t ( )
@@ -249,7 +249,7 @@ defmodule Task.Supervisor do
249
249
250
250
Each element will be prepended to the given `args` and processed by its
251
251
own task. The tasks will be spawned under the given `supervisor` and
252
- linked to the caller process, similarly to `async/4 `.
252
+ linked to the caller process, similarly to `async/5 `.
253
253
254
254
When streamed, each task will emit `{:ok, value}` upon successful
255
255
completion or `{:exit, reason}` if the caller is trapping exits.
@@ -308,7 +308,7 @@ defmodule Task.Supervisor do
308
308
309
309
Each element in `enumerable` is passed as argument to the given function `fun`
310
310
and processed by its own task. The tasks will be spawned under the given
311
- `supervisor` and linked to the caller process, similarly to `async/2 `.
311
+ `supervisor` and linked to the caller process, similarly to `async/3 `.
312
312
313
313
See `async_stream/6` for discussion, options, and examples.
314
314
"""
@@ -325,7 +325,7 @@ defmodule Task.Supervisor do
325
325
326
326
Each element in `enumerable` will be prepended to the given `args` and processed
327
327
by its own task. The tasks will be spawned under the given `supervisor` and
328
- will not be linked to the caller process, similarly to `async_nolink/4 `.
328
+ will not be linked to the caller process, similarly to `async_nolink/5 `.
329
329
330
330
See `async_stream/6` for discussion, options, and examples.
331
331
"""
@@ -350,7 +350,7 @@ defmodule Task.Supervisor do
350
350
Each element in `enumerable` is passed as argument to the given function `fun`
351
351
and processed by its own task. The tasks will be spawned under the given
352
352
`supervisor` and will not be linked to the caller process, similarly
353
- to `async_nolink/2 `.
353
+ to `async_nolink/3 `.
354
354
355
355
See `async_stream/6` for discussion and examples.
356
356
"""
@@ -387,17 +387,17 @@ defmodule Task.Supervisor do
387
387
Note that the spawned process is not linked to the caller, but
388
388
only to the supervisor. This command is useful in case the
389
389
task needs to perform side-effects (like I/O) and you have no
390
- interest on its results nor if it completes successfully.
390
+ interest in its results nor if it completes successfully.
391
391
392
392
## Options
393
393
394
394
* `:restart` - the restart strategy, may be `:temporary` (the default),
395
395
`:transient` or `:permanent`. `:temporary` means the task is never
396
396
restarted, `:transient` means it is restarted if the exit is not
397
397
`:normal`, `:shutdown` or `{:shutdown, reason}`. A `:permanent` restart
398
- strategy means it is always restarted. It defaults to `:temporary`.
398
+ strategy means it is always restarted.
399
399
400
- * `:shutdown` - `:brutal_kill` if the tasks must be killed directly on shutdown
400
+ * `:shutdown` - `:brutal_kill` if the task must be killed directly on shutdown
401
401
or an integer indicating the timeout value, defaults to 5000 milliseconds.
402
402
403
403
"""
@@ -413,7 +413,7 @@ defmodule Task.Supervisor do
413
413
@ doc """
414
414
Starts a task as a child of the given `supervisor`.
415
415
416
- Similar to `start_child/2 ` except the task is specified
416
+ Similar to `start_child/3 ` except the task is specified
417
417
by the given `module`, `fun` and `args`.
418
418
"""
419
419
@ spec start_child ( Supervisor . supervisor ( ) , module , atom , [ term ] , keyword ) ::
0 commit comments