Skip to content

Commit 5093bab

Browse files
committed
Document GenServer shutdown default
1 parent b381ab3 commit 5093bab

File tree

2 files changed

+4
-3
lines changed

2 files changed

+4
-3
lines changed

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -199,7 +199,7 @@ The type system was made possible thanks to a partnership between [CNRS](https:/
199199
200200
#### Elixir
201201
202-
* `require SomeModule` no longer expands to the given module at compile-time, but it still returns the module at runtime. Note that while Elixir does not guarantee macros will expand to certain constructs, but since this can break code relying on the previous behaviour, such as `require(SomeMod).some_macro()`, we are adding this note to the release notes
202+
* `require SomeModule` no longer expands to the given module at compile-time, but it still returns the module at runtime. Note that while Elixir does not guarantee macros will expand to certain constructs, but since this can break code relying on the previous behaviour, such as `require(SomeMod).some_macro()`, we are adding this note to the CHANGELOG
203203
204204
### 3. Hard deprecations
205205

lib/elixir/lib/gen_server.ex

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -210,13 +210,14 @@ defmodule GenServer do
210210
* [`:restart`](`m:Supervisor#module-restart-values-restart`) - when the
211211
child should be restarted, defaults to `:permanent`
212212
* [`:shutdown`](`m:Supervisor#module-shutdown-values-shutdown`) - how to
213-
shut down the child, either immediately or by giving it time to shut down
213+
shut down the child, either immediately or by giving it time to shut down,
214+
defaults to `5_000`
214215
215216
For example:
216217
217218
use GenServer, restart: :transient, shutdown: 10_000
218219
219-
See the ["Child specification"](`m:Supervisor#module-child_spec-1-function`) section in the `Supervisor` module for more
220+
See the ["Child specification"](`m:Supervisor#module-child-specification`) section in the `Supervisor` module for more
220221
detailed information. The `@doc` annotation immediately preceding
221222
`use GenServer` will be attached to the generated `child_spec/1` function.
222223

0 commit comments

Comments
 (0)