Description
Currently the iex h helper does not support accessing erlang documentation.
iex> h :crypto
:crypto is an Erlang module and, as such, it does not have Elixir-style docs
Since erlang functions are first class citizens in the Elixir language, Elixir
should provide a means of providing this documentation in iex , if possible.
I have made some progress in this area as documented in these threads on the
elixir-lang-core email list.
https://groups.google.com/forum/#!topic/elixir-lang-core/nnyBdZ22hqk
https://groups.google.com/forum/#!topic/elixir-lang-core/hIj-cLMUDxM
There are two git repos that are being used for experimenting with these ideas.
https://github.com/bbense/iex_h_helper
https://github.com/bbense/erlman
The problem is that there isn't a platform independent way to provide the erlang
documentation w/o including the erlang documentation in the elixir src tree. As
documented in the threads above, adding set of module behaviors to implement
documentation lookup would allow this problem to be solved.
My plan is that once I have a version of iex_h_helper that implements all the
h functions of elixir/lib/iex/lib/introspection.ex
is to use that as a base to create a
patch to the main elixir branch. This would allow switching the backends behind
the h command to include platform specific code for documentation lookups.