Skip to content

Commit 01fd433

Browse files
committed
Improve docs for Application.put_all_env/2
1 parent 8f64ca0 commit 01fd433

File tree

1 file changed

+16
-3
lines changed

1 file changed

+16
-3
lines changed

Diff for: lib/elixir/lib/application.ex

+16-3
Original file line numberDiff line numberDiff line change
@@ -817,16 +817,29 @@ defmodule Application do
817817
end
818818

819819
@doc """
820-
Puts the environment for multiple apps at the same time.
820+
Puts the environment for multiple applications at the same time.
821821
822822
The given config should not:
823823
824824
* have the same application listed more than once
825825
* have the same key inside the same application listed more than once
826826
827-
If those conditions are not met, it will raise.
827+
If those conditions are not met, this function will raise.
828+
829+
This function receives the same options as `put_env/4`. Returns `:ok`.
830+
831+
## Examples
832+
833+
Application.put_all_env(
834+
my_app: [
835+
key: :value,
836+
another_key: :another_value
837+
],
838+
another_app: [
839+
key: :value
840+
]
841+
)
828842
829-
It receives the same options as `put_env/4`. Returns `:ok`.
830843
"""
831844
@doc since: "1.9.0"
832845
@spec put_all_env([{app, [{key, value}]}], timeout: timeout, persistent: boolean) :: :ok

0 commit comments

Comments
 (0)