diff options
author | José Valim <jose.valim@plataformatec.com.br> | 2019-01-28 22:30:26 +0100 |
---|---|---|
committer | José Valim <jose.valim@plataformatec.com.br> | 2019-01-28 22:30:26 +0100 |
commit | 5af83fa1b914179fdfd5b994faef39c8f3a6a57f (patch) | |
tree | e720e53197b33ffc1ae10fa04fee2f981707f4b4 | |
parent | dc030376d6a3bf4165852f6b6e2ef5f7ce3c98ad (diff) | |
download | elixir-5af83fa1b914179fdfd5b994faef39c8f3a6a57f.tar.gz |
Add docs to Kernel.CLI entry
-rw-r--r-- | lib/elixir/lib/kernel/cli.ex | 16 |
1 files changed, 12 insertions, 4 deletions
diff --git a/lib/elixir/lib/kernel/cli.ex b/lib/elixir/lib/kernel/cli.ex index eaa5881f2..e76ca07e8 100644 --- a/lib/elixir/lib/kernel/cli.ex +++ b/lib/elixir/lib/kernel/cli.ex @@ -58,19 +58,25 @@ defmodule Kernel.CLI do end end - @doc false + @doc """ + Parses the CLI arguments. Made public for testing. + """ def parse_argv(argv) do parse_argv(argv, @blank_config) end - @doc false + @doc """ + Process CLI commands. Made public for testing. + """ def process_commands(config) do results = Enum.map(Enum.reverse(config.commands), &process_command(&1, config)) errors = for {:error, msg} <- results, do: msg Enum.reverse(config.errors, errors) end - @doc false + @doc """ + Shared helper for error formatting on CLI tools. + """ def format_error(kind, reason, stacktrace) do {blamed, stacktrace} = Exception.blame(kind, reason, stacktrace) @@ -88,7 +94,9 @@ defmodule Kernel.CLI do [iodata, ?\n, Exception.format_stacktrace(prune_stacktrace(stacktrace))] end - @doc false + @doc """ + Function invoked across nodes for `--rpc-eval`. + """ def rpc_eval(expr) do wrapper(fn -> :elixir.eval(to_charlist(expr), [], []) end) catch |