Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Aug 7, 2025
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
44bcf19
updated documentation for actor.start
Daniel-Shunom Aug 6, 2025
e6871e7
updated CHANGELOG
Daniel-Shunom Aug 6, 2025
2c85359
added set_timeout function
Daniel-Shunom Aug 6, 2025
e0cc7bb
updated CHANGELOG
Daniel-Shunom Aug 6, 2025
9e38e8f
ran format check
Daniel-Shunom Aug 6, 2025
9ec6a19
removed set_timeout addition
Daniel-Shunom Aug 7, 2025
37ce256
updated CHANGELOG
Daniel-Shunom Aug 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down
8 changes: 1 addition & 7 deletions src/gleam/otp/actor.gleam
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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) {
Expand Down