diff --git a/CHANGELOG.md b/CHANGELOG.md index a887d38..6e8af04 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,9 @@ # Changelog +## v1.1.1 - 2025-08-06 + +- Updated `actor.start` documentation to reflect current use case. + ## v1.1.0 - 2025-08-05 - The `call` function in the `gleam/otp/actor` module gains the labels diff --git a/src/gleam/otp/actor.gleam b/src/gleam/otp/actor.gleam index a325b86..a2dce58 100644 --- a/src/gleam/otp/actor.gleam +++ b/src/gleam/otp/actor.gleam @@ -588,13 +588,7 @@ type StartInitMessage(data) { Mon(process.Down) } -/// Start an actor from a given specification. If the actor's `init` function -/// returns an error or does not return within `init_timeout` then an error is -/// returned. -/// -/// If you do not need to specify the initialisation behaviour of your actor -/// consider using the `start` function. -/// +/// Starts an actor from a given `Builder`. On failure, `start` returns a `StartError` pub fn start( builder: Builder(state, msg, return), ) -> Result(Started(return), StartError) {