Skip to content
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

Linking (internally) to non-existent function/types #192

Closed
eksperimental opened this issue Feb 10, 2015 · 4 comments
Closed

Linking (internally) to non-existent function/types #192

eksperimental opened this issue Feb 10, 2015 · 4 comments
Labels

Comments

@eksperimental
Copy link
Contributor

you can see in
http://elixir-lang.org/docs/master/elixir/Dict.html
Where it reads "Based on these functions, Dict generates default implementations for the following functions:"

funtion get/2 doesn't exist, but it is still being referenced.
note that the markdown for this code is get/2, so it's being autolinks.

what is it is in reality, is a callback: so it should link to : http://elixir-lang.org/docs/master/elixir/Dict.html#c:get/2

But maybe we shouldn't link at all. (get/3 will link to the function, so it's not consistent)
I'm not too sure which logic to follow here.

@eksperimental eksperimental changed the title Linking (internally) to non-existent functions Linking (internally) to non-existent function Feb 10, 2015
@milmazz
Copy link
Member

milmazz commented Aug 4, 2015

@josevalim @eksperimental I think this issue is already fix.

After review the Dict module documentation, in particular this section:

Based on these functions, Dict generates default implementations for the following functions:

  • drop/2
  • equal?/2
  • fetch!/2
  • get/2
  • get/3

get/2 does not link to a nonexistent function anymore. Also, does not link to the proper callback (IMHO we should link to the proper callback). But I want to know what do you think of this.

@ericmj
Copy link
Member

ericmj commented Aug 4, 2015

It shouldn't link to the callback unless a callback link is used, maybe Dict docs should be changed to use c:... links. We should automatically create links for all arities of functions with default arguments though.

@josevalim
Copy link
Member

#110 is the same issue, except it happens for types.

@josevalim josevalim changed the title Linking (internally) to non-existent function Linking (internally) to non-existent function/types Aug 7, 2015
@josevalim
Copy link
Member

Yes, docs should be changed instead.

This issue was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Development

No branches or pull requests

4 participants