-
Notifications
You must be signed in to change notification settings - Fork 324
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
Parameterized type in function spec generates an extra anchor tag #657
Comments
None of them should link to |
@ericmj I think you mentioned about docs for "type definition" in which it's true that parameters in parameterized types can be arbitrary so not to be linked even if it is named as On the other hand, in docs for "function typespecs", actual, concrete types can be specified as parameters in parameterized types, so they are to be linked. For instance, @type t :: term
@type parameterized_t(t) :: {:ok, t} | {:error, term}
@spec fun(t) :: parameterized_t(t)
def fun(val) do
# some logic returning parameterized_t/1
end The above code should generate docs for fun(<a href="#t:t/0">t</a>) :: <a href="#t:parameterized_t/1">parameterized_t</a>(<a href="#t:t/0">t</a>) I have PR'ed the fix achieving the above behavior, so please review it ❤️ => #694 |
I have something similar to the following defined:
When docs are generated for this, the entry for
append
looks likeIt appears that it is trying to add another link to the entry for type
t
The text was updated successfully, but these errors were encountered: