-
Notifications
You must be signed in to change notification settings - Fork 3k
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.
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
edoc generates several returns for functions having several specification clauses #7576
Comments
pguyot
added a commit
to pguyot/edown
that referenced
this issue
Aug 19, 2023
This is a workaround for bug erlang/otp#7576 Signed-off-by: Paul Guyot <[email protected]>
pguyot
added a commit
to pguyot/AtomVM
that referenced
this issue
Aug 19, 2023
Implement the following functions: - `erlang:spawn_link/1` - `erlang:spawn_link/3` - `erlang:exit/2` - `lists:usort/1` - `lists:usort/2` Fix options of `spawn_opt/2` by factorizing it with `spawn_opt/4` Also rewrite `spawn/1` and `spawn/3` in Erlang and update tests accordingly Implement info `links` for `erlang:process_info/2` Also narrow type specification of `erlang:process_info/2` Also add documentation for `erlang:exit/1` Fix a bug where exit reason was incorrectly a tuple for exception of class exit No longer dump crash logs when exit reason is normal Also update `.gitignore` Also isolate libs tests Also remove useless second installation of Erlang/OTP in documentation workflow Also bump OTP and Elixir versions in documentation workflow Also update edown with a patch to fix crash when parsing updated doc for `erlang:process_info/2` See: - uwiger/edown#23 - erlang/otp#7576 Signed-off-by: Paul Guyot <[email protected]>
pguyot
added a commit
to pguyot/AtomVM
that referenced
this issue
Aug 19, 2023
Implement the following functions: - `erlang:spawn_link/1` - `erlang:spawn_link/3` - `erlang:exit/2` - `lists:usort/1` - `lists:usort/2` Fix options of `spawn_opt/2` by factorizing it with `spawn_opt/4` Also rewrite `spawn/1` and `spawn/3` in Erlang and update tests accordingly Implement info `links` for `erlang:process_info/2` Also narrow type specification of `erlang:process_info/2` Also add documentation for `erlang:exit/1` Fix a bug where exit reason was incorrectly a tuple for exception of class exit No longer dump crash logs when exit reason is normal Also update `.gitignore` Also isolate libs tests Also remove useless second installation of Erlang/OTP in documentation workflow Also bump OTP and Elixir versions in documentation workflow Also update edown with a patch to fix crash when parsing updated doc for `erlang:process_info/2` See: - uwiger/edown#23 - erlang/otp#7576 Signed-off-by: Paul Guyot <[email protected]>
pguyot
added a commit
to pguyot/AtomVM
that referenced
this issue
Aug 19, 2023
Implement the following functions: - `erlang:spawn_link/1` - `erlang:spawn_link/3` - `erlang:exit/2` - `lists:usort/1` - `lists:usort/2` Fix options of `spawn_opt/2` by factorizing it with `spawn_opt/4` Also rewrite `spawn/1` and `spawn/3` in Erlang and update tests accordingly Implement info `links` for `erlang:process_info/2` Also narrow type specification of `erlang:process_info/2` Also add documentation for `erlang:exit/1` Fix a bug where exit reason was incorrectly a tuple for exception of class exit No longer dump crash logs when exit reason is normal Also update `.gitignore` Also isolate libs tests Also remove useless second installation of Erlang/OTP in documentation workflow Also bump OTP and Elixir versions in documentation workflow Also update edown with a patch to fix crash when parsing updated doc for `erlang:process_info/2` See: - uwiger/edown#23 - erlang/otp#7576 Signed-off-by: Paul Guyot <[email protected]>
pguyot
added a commit
to pguyot/AtomVM
that referenced
this issue
Aug 24, 2023
Implement the following functions: - `erlang:spawn_link/1` - `erlang:spawn_link/3` - `erlang:exit/2` - `lists:usort/1` - `lists:usort/2` Fix options of `spawn_opt/2` by factorizing it with `spawn_opt/4` Also rewrite `spawn/1` and `spawn/3` in Erlang and update tests accordingly Implement info `links` for `erlang:process_info/2` Also narrow type specification of `erlang:process_info/2` Also add documentation for `erlang:exit/1` Fix a bug where exit reason was incorrectly a tuple for exception of class exit No longer dump crash logs when exit reason is normal Also update `.gitignore` Also isolate libs tests Also remove useless second installation of Erlang/OTP in documentation workflow Also bump OTP and Elixir versions in documentation workflow Also update edown with a patch to fix crash when parsing updated doc for `erlang:process_info/2` See: - uwiger/edown#23 - erlang/otp#7576 Signed-off-by: Paul Guyot <[email protected]>
pguyot
added a commit
to pguyot/AtomVM
that referenced
this issue
Aug 25, 2023
Implement the following functions: - `erlang:spawn_link/1` - `erlang:spawn_link/3` - `erlang:exit/2` - `lists:usort/1` - `lists:usort/2` Fix options of `spawn_opt/2` by factorizing it with `spawn_opt/4` Also rewrite `spawn/1` and `spawn/3` in Erlang and update tests accordingly Implement info `links` for `erlang:process_info/2` Also narrow type specification of `erlang:process_info/2` Also add documentation for `erlang:exit/1` Fix a bug where exit reason was incorrectly a tuple for exception of class exit No longer dump crash logs when exit reason is normal Also update `.gitignore` Also isolate libs tests Also remove useless second installation of Erlang/OTP in documentation workflow Also bump OTP and Elixir versions in documentation workflow Also update edown with a patch to fix crash when parsing updated doc for `erlang:process_info/2` See: - uwiger/edown#23 - erlang/otp#7576 Signed-off-by: Paul Guyot <[email protected]>
pguyot
added a commit
to pguyot/AtomVM
that referenced
this issue
Aug 26, 2023
Also narrow type specification of `erlang:process_info/2` Also update edown with a patch to fix crash when parsing updated doc for `erlang:process_info/2` See: - uwiger/edown#23 - erlang/otp#7576 Signed-off-by: Paul Guyot <[email protected]>
pguyot
added a commit
to pguyot/AtomVM
that referenced
this issue
Aug 27, 2023
Also narrow type specification of `erlang:process_info/2` Also update edown with a patch to fix crash when parsing updated doc for `erlang:process_info/2` See: - uwiger/edown#23 - erlang/otp#7576 Signed-off-by: Paul Guyot <[email protected]>
pguyot
added a commit
to pguyot/AtomVM
that referenced
this issue
Aug 28, 2023
Also narrow type specification of `erlang:process_info/2` Also update edown with a patch to fix crash when parsing updated doc for `erlang:process_info/2` See: - uwiger/edown#23 - erlang/otp#7576 Signed-off-by: Paul Guyot <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Describe the bug
When generating documentation about a function that has a spec with several clauses and a
@returns
tag, edoc duplicates the content of thereturns
tag.To Reproduce
Create a file edoc_returns.erl
Generate documentation with:
Check generated edoc_returns.html. It does contain:
Expected behavior
The returns paragraph should not be duplicated.
Affected versions
OTP22 (
{edoc,"EDoc","0.11"}
) is not affected. This was observed with:{edoc,"EDoc","0.12"}
){edoc,"EDoc, the Erlang documentation engine","1.1"}
){edoc,"EDoc, the Erlang documentation engine","1.2"}
){edoc,"EDoc, the Erlang documentation engine","1.2"}
)The text was updated successfully, but these errors were encountered: