ExDoc already supports auto-linking for modules and functions inside the
docstring. See, for example,
http://elixir-lang.org/docs/stable/elixir/Enum.html#filter/2.
On Tue, Jul 19, 2016 at 1:41 AM, eksperimental <eksperimen...@autistici.org>
wrote:
> I have been craving for this feature for a long time.
> I think it will help with a lot with things such as including
> discoverability of functions or leading people in the right direction
> with very little effort from the documentation side.
>
> A @see_also (it could be named @related, or any other better name).
>
> Let's say in Enum module
>
> @spec at(t, index, default) :: element | default
> @see_also [:fetch!/2, :fetch/2]
> def at(enumerable, index, default \\ nil) do
> case fetch(enumerable, index) do
> {:ok, h} -> h
> :error -> default
> end
> end
>
> @spec filter(t, (element -> as_boolean(term))) :: list
> @see_also :reject
> def filter(enumerable, fun) when is_list(enumerable)
> and is_function(fun, 1) do
> ...
>
> ExDoc could take advantage of such feature, and automatically linked to
> suggested functions.
>
> --
> You received this message because you are subscribed to the Google Groups
> "elixir-lang-core" group.
> To unsubscribe from this group and stop receiving emails from it, send an
> email to elixir-lang-core+unsubscr...@googlegroups.com.
> To view this discussion on the web visit
> https://groups.google.com/d/msgid/elixir-lang-core/20160719054127.7a04ed2d.eksperimental%40autistici.org
> .
> For more options, visit https://groups.google.com/d/optout.
>
--
You received this message because you are subscribed to the Google Groups
"elixir-lang-core" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to elixir-lang-core+unsubscr...@googlegroups.com.
To view this discussion on the web visit
https://groups.google.com/d/msgid/elixir-lang-core/CAAPY6eP4L3ojoqZN5QSOVHm7zqFaQ69iRSm3-cvjb%2Brw0iDUkA%40mail.gmail.com.
For more options, visit https://groups.google.com/d/optout.
