Eh

Lookup Elixir documentation for Elixir terms.

Eh works in the same way as Elixir’s built-in IEx.Helpers.h, except that it exposes that functionality as a mix task.

Summary

Functions

List all public functions of a module

Lookup and print documentation on an Elixir term

Functions

functions(module)

List all public functions of a module.

Examples:

iex> Eh.functions("Eh")
["Eh.main/1", "Eh.lookup/1", "Eh.functions/1"]
lookup(definition)

Lookup and print documentation on an Elixir term.

This is intended to work like using IEx.Helpers.h in the iex shell, but without actually firing up iex.

definition can be something like:

  • String
  • String.to_integer
  • IO.ANSI.Docs.print
  • IO.ANSI.Docs.print/2