Skip to content

Commit 7f2dc0c

Browse files
authored
Update getaddr function documentation for Timeout
Clarified the description of the Timeout parameter in the getaddr function.
1 parent 5859856 commit 7f2dc0c

1 file changed

Lines changed: 1 addition & 2 deletions

File tree

lib/kernel/src/inet.erl

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2808,8 +2808,7 @@ Returns the [IP address](`t:ip_address/0`) for `Host` as a tuple of integers.
28082808
`Host` can be an [IP address](`t:ip_address/0`), a single `t:hostname/0`,
28092809
or a fully qualified `t:hostname/0`.
28102810

2811-
The optional `Timeout` parameter specifies a time-out in milliseconds.
2812-
Defaults to `infinity`.
2811+
`Timeout` specifies a time-out in milliseconds, or the atom `infinity`.
28132812
""".
28142813
-spec getaddr(Host :: ip_address() | hostname(),
28152814
Family :: address_family(),

0 commit comments

Comments
 (0)