I don't have strong feelings about how this issue is resolved, but I'm very
interested in having some sort of tidy resolution. FWIW, I posted a note about
this topic to ElixirForum back in February:
Not sure how to document defdelegate entries
https://elixirforum.com/t/not-sure-how-to-document-defdelegate-entries/20502
I also note that belaustegui commented on this about the same time:
Defdelegate does not allow access to docs
https://elixirforum.com/t/defdelegate-does-not-allow-access-to-docs/12688
Dave's first suggestion (if a defdelegate does not have its own documentation,
could it receive a copy of the documentation of the function it delegates to)
would work fine for me, but I'm slightly concerned about backward compatibility.
In some existing cases, an implementation @doc entry might not be appropriate
for use with a defdelegate.
The @see syntax doesn't have this problem. It's also more explicit and it
allows
more flexibility for what documentation gets used. So, I think I'd lean that
way.
-r
--
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 [email protected].
To view this discussion on the web visit
https://groups.google.com/d/msgid/elixir-lang-core/72452964-30EB-48B6-B11C-3384F4B6EFBB%40gmail.com.
For more options, visit https://groups.google.com/d/optout.
