Skip to content

Commit 0e9bd2c

Browse files
committed
Remove doc for deprecated callback
1 parent 00b109f commit 0e9bd2c

File tree

1 file changed

+0
-17
lines changed

1 file changed

+0
-17
lines changed

lib/elixir/lib/gen_server.ex

Lines changed: 0 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -790,23 +790,6 @@ defmodule GenServer do
790790
@callback format_status(status :: :gen_server.format_status()) ::
791791
new_status :: :gen_server.format_status()
792792

793-
@doc """
794-
Invoked in some cases to retrieve a formatted version of the `GenServer` status:
795-
796-
* one of `:sys.get_status/1` or `:sys.get_status/2` is invoked to get the
797-
status of the `GenServer`; in such cases, `reason` is `:normal`
798-
799-
* the `GenServer` terminates abnormally and logs an error; in such cases,
800-
`reason` is `:terminate`
801-
802-
This callback can be useful to control the *appearance* of the status of the
803-
`GenServer`. For example, it can be used to return a compact representation of
804-
the `GenServer`'s state to avoid having large state terms printed.
805-
806-
`pdict_and_state` is a two-elements list `[pdict, state]` where `pdict` is a
807-
list of `{key, value}` tuples representing the current process dictionary of
808-
the `GenServer` and `state` is the current state of the `GenServer`.
809-
"""
810793
@doc deprecated: "Use format_status/1 callback instead"
811794
@callback format_status(reason, pdict_and_state :: list) :: term
812795
when reason: :normal | :terminate

0 commit comments

Comments
 (0)