hex_tarball.unpack_docs

You're seeing just the function unpack_docs, go back to hex_tarball module for more information.
Link to this function

unpack_docs(Tarball, Output)

View Source

Specs

unpack_docs(tarball(), memory) -> {ok, contents()} | {error, term()};
           (tarball(), filename()) -> ok | {error, term()}.
Link to this function

unpack_docs(Tarball, Output, Config)

View Source

Specs

unpack_docs(tarball(), memory, hex_core:config()) -> {ok, contents()} | {error, term()};
           (tarball(), filename(), hex_core:config()) -> ok | {error, term()}.

Unpacks a documentation tarball.

Examples:

  > hex_tarball:unpack_docs(Tarball, memory).
  {ok, [{"index.html", <<"<!doctype>">>}, ...]}
 
  > hex_tarball:unpack_docs(Tarball, "path/to/unpack").
  ok