Added actor.set_timeout function and improved documentation for actor.start

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## v1.1.1 - 2025-08-06
+
+- Updated `actor.start` documentation to reflect current use case.
+- Added `actor.set_timeout` function for setting `Builder` timeout.
+
 ## v1.1.0 - 2025-08-05
 
 - The `call` function in the `gleam/otp/actor` module gains the labels

src/gleam/otp/actor.gleam

@@ -368,6 +368,16 @@ pub fn new_with_initialiser(
   )
 }
 
+/// Set the timeout for a `Builder` in milliseconds. This timeout value
+/// determines how long the actor should await intitialisation before returning 
+/// an error.
+pub fn set_timeout(
+  timeout: Int,
+  builder: Builder(state, message, return),
+) -> Builder(state, message, return) {
+  Builder(..builder, initialisation_timeout: timeout)
+}
+
 /// Set the message handler for the actor. This callback function will be
 /// called each time the actor receives a message.
 ///
@@ -588,13 +598,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) {