Skip to content

Fixes #9081 by improving documentation of GenServer.server() type. #9082

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
fertapric merged 2 commits into from
May 27, 2019
Merged

Fixes #9081 by improving documentation of GenServer.server() type. #9082

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8edc730
Fixes #9081 by improving documentation of GenServer.server() type.
Qqwy May 27, 2019
1da1407
Update gen_server.ex
fertapric May 27, 2019
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
12 changes: 10 additions & 2 deletions lib/elixir/lib/gen_server.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -717,8 +717,13 @@ defmodule GenServer do
@typedoc "Debug options supported by the `start*` functions"
@type debug :: [:trace | :log | :statistics | {:log_to_file, Path.t()}]

@typedoc "The server reference"
@type server :: pid | name | {atom, node}
@typedoc """
The server reference.

This is either a plain PID or a value representing a registered name.
See the "Name registration" section of this document for more information.
"""
@type server :: pid | name | {atom, node} | {:via, registry :: module(), key :: term()}

@typedoc """
Tuple describing the client of a call request.
Expand Down Expand Up @@ -1022,6 +1027,9 @@ defmodule GenServer do
not yet connected to the caller one, the semantics differ
depending on the used Erlang/OTP version.

`server` can be any of the values described in the "Name registration"
section of the documentation for this module.

Before Erlang/OTP 21, the call is going to block until a
connection happens. This was done to guarantee ordering.
Starting with Erlang/OTP 21, both Erlang and Elixir do
Expand Down