You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Describe the bug
There are duplicate entries in the chunk file docs for system_info/1.
This seems due to the fact that the doc is broken in several sections.
The erlang:system_info/1 documentation has been fixed in #7472 which will be part of the next patch (which will also update the website docs).
Regarding multiple entries in the chunk, that works as intended. In Erlang we can document separate clauses of the same MFA using different docs. In the doc chunks this is handles by having multiple entries with the same FA in the list of docs. When a renderer encounters this they can either treat them as separate entries (which is what ExDoc does) or just as one entry (which is what the h in the erlang shell does*). For example here is how the text for erlang:halt/1 looks like:
1> h(erlang,halt,1).
-spec halt(Status :: non_neg_integer()) -> no_return().
The same as calling halt(Status, []). Example:
> halt(17).
os_prompt% echo $?
17
os_prompt%
-spec halt(Abort :: abort) -> no_return().
Since:
OTP R15B01
The same as calling halt(abort, []).
-spec halt(CrashDumpSlogan :: string()) -> no_return().
The same as calling halt(CrashDumpSlogan, []).
Note that there are three entries just as in the html docs.
* or rather should do, when I checked to verify the behavior I found that a bug had sneaked in while fixing an issue with the @equiv metadata. The bug is fixed in #7502.
Describe the bug
There are duplicate entries in the chunk file docs for
system_info/1
.This seems due to the fact that the doc is broken in several sections.
To Reproduce
Expected behavior
Docs should all be grouped in a single entry.
Affected versions
26.0.1
Additional context
Originally reported in Elixir: elixir-lang/elixir#12796.
The text was updated successfully, but these errors were encountered: