-
Notifications
You must be signed in to change notification settings - Fork 334
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
Use EDoc link for erlang type #1065
Conversation
b342e93
to
ed21fe6
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good to me.
FWIW, people can do:
defmodule :foo do
@moduledoc "..."
end
and ExDoc will generate docs for it, so the heuristic that :module
is documented using EDoc fails here. Personally I think it's an ok heuristic, but just mentioning this for completeness.
Fixes #1005
This PR only solves part of the problem, in order to close #1005 we'd need to make this work as well.
@moduledoc """
See `t::sets.set/0`.
"""
If you'd like to work on that aspect in a separate PR, that would be appreciated!
@wojtekmach Oh, I didn't know that's possible ( I'm not sure looking into |
In this case wouldn’t it be better to look at the original text and see if
it stars with “:”?
--
*José Valimwww.plataformatec.com.br
<http://www.plataformatec.com.br/>Founder and Director of R&D*
|
As @josevalim wrote here
so it's not a matter of whether it's Erlang or Elixir, but what tool was used to build the documentation for that particular module. As José mentioned elsewhere, given different Erlang projects might use different tools, it's a safer bet to only use EDoc style urls for Erlang stdlib and leave others not linked. |
@josevalim mentioned that at #1066 (comment) I'm going to close this PR as it's not clear "adding more link to external erlang project" is the "right" direction to go at this moment. |
Fixes #1005