Skip to content

Commit

Permalink
Improve task documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
lpil committed Nov 10, 2024
1 parent 78f0d93 commit 00e3a2f
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions src/gleam/otp/task.gleam
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
//// A task is a kind of process that performs a single task and then shuts
//// down. Commonly tasks are used to convert sequential code into concurrent
//// code by performing computation in another process.
//// A task is a kind of process that computes a value and then sends the result back
//// to its parent. Commonly multiple tasks are used to compute multiple things at
//// once.
////
//// If you do not care to receive a result back at the end then you should not
//// use this module, `actor` or `process` are likely more suitable.
////
//// ```gleam
//// let task = task.async(fn() { do_some_work() })
Expand Down

0 comments on commit 00e3a2f

Please sign in to comment.