Skip to content

Mention child order in docs for Supervisor.child_spec/2 #14373

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 1 commit into from
Mar 27, 2025
Merged

Mention child order in docs for Supervisor.child_spec/2 #14373

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 6 additions & 0 deletions lib/elixir/lib/supervisor.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -990,6 +990,12 @@ defmodule Supervisor do
value, or if it fails, the child specification is discarded and this function
returns `{:error, error}` where `error` is a term containing information about
the error and child specification.

> #### Order Among Children {: .tip}
>
> The child specification is **appended** to the children of `supervisor`.
> This guarantees that semantics of things such as the `:rest_for_one` strategy
> are preserved correctly.
"""
@spec start_child(
supervisor,
Expand Down
Loading