Skip to content

Commit e15c854

Browse files
committed
Rename Application.format_reason/1 to format_error
Makes the function name consistent with OTP modules, which all use format_error to format reason in {:error, reason}
1 parent 29313e8 commit e15c854

File tree

4 files changed

+21
-21
lines changed

4 files changed

+21
-21
lines changed

lib/elixir/lib/application.ex

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -323,10 +323,10 @@ defmodule Application do
323323
`ensure_started/2, `stop/1`, `load/1` and `unload/1`,
324324
returns a string.
325325
"""
326-
@spec format_reason(any) :: String.t
327-
def format_reason(reason) do
326+
@spec format_error(any) :: String.t
327+
def format_error(reason) do
328328
try do
329-
impl_format_reason(reason)
329+
impl_format_error(reason)
330330
catch
331331
# A user could create an error that looks like a builtin one
332332
# causing an error.
@@ -336,68 +336,68 @@ defmodule Application do
336336
end
337337

338338
# exit(:normal) call is special cased, undo the special case.
339-
defp impl_format_reason({{:EXIT, :normal}, {mod, :start, args}}) do
339+
defp impl_format_error({{:EXIT, :normal}, {mod, :start, args}}) do
340340
Exception.format_exit({:normal, {mod, :start, args}})
341341
end
342342

343343
# {:error, reason} return value
344-
defp impl_format_reason({reason, {mod, :start, args}}) do
344+
defp impl_format_error({reason, {mod, :start, args}}) do
345345
Exception.format_mfa(mod, :start, args) <> " returned an error: " <>
346346
Exception.format_exit(reason)
347347
end
348348

349349
# error or exit(reason) call, use exit reason as reason.
350-
defp impl_format_reason({:bad_return, {{mod, :start, args}, {:EXIT, reason}}}) do
350+
defp impl_format_error({:bad_return, {{mod, :start, args}, {:EXIT, reason}}}) do
351351
Exception.format_exit({reason, {mod, :start, args}})
352352
end
353353

354354
# bad return value
355-
defp impl_format_reason({:bad_return, {{mod, :start, args}, return}}) do
355+
defp impl_format_error({:bad_return, {{mod, :start, args}, return}}) do
356356
Exception.format_mfa(mod, :start, args) <>
357357
" returned a bad value: " <> inspect(return)
358358
end
359359

360-
defp impl_format_reason({:already_started, app}) when is_atom(app) do
360+
defp impl_format_error({:already_started, app}) when is_atom(app) do
361361
"already started application #{app}"
362362
end
363363

364-
defp impl_format_reason({:not_started, app}) when is_atom(app) do
364+
defp impl_format_error({:not_started, app}) when is_atom(app) do
365365
"not started application #{app}"
366366
end
367367

368-
defp impl_format_reason({:bad_application, app}) do
368+
defp impl_format_error({:bad_application, app}) do
369369
"bad application: #{inspect(app)}"
370370
end
371371

372-
defp impl_format_reason({:already_loaded, app}) when is_atom(app) do
372+
defp impl_format_error({:already_loaded, app}) when is_atom(app) do
373373
"already loaded application #{app}"
374374
end
375375

376-
defp impl_format_reason({:not_loaded, app}) when is_atom(app) do
376+
defp impl_format_error({:not_loaded, app}) when is_atom(app) do
377377
"not loaded application #{app}"
378378
end
379379

380-
defp impl_format_reason({:invalid_restart_type, restart}) do
380+
defp impl_format_error({:invalid_restart_type, restart}) do
381381
"invalid application restart type: #{inspect(restart)}"
382382
end
383383

384-
defp impl_format_reason({:invalid_name, name}) do
384+
defp impl_format_error({:invalid_name, name}) do
385385
"invalid application name: #{inspect(name)}"
386386
end
387387

388-
defp impl_format_reason({:invalid_options, opts}) do
388+
defp impl_format_error({:invalid_options, opts}) do
389389
"invalid application options: #{inspect(opts)}"
390390
end
391391

392-
defp impl_format_reason({:badstartspec, spec}) do
392+
defp impl_format_error({:badstartspec, spec}) do
393393
"bad application start specs: #{inspect(spec)}"
394394
end
395395

396-
defp impl_format_reason({'no such file or directory', file}) do
396+
defp impl_format_error({'no such file or directory', file}) do
397397
"could not find application file: #{file}"
398398
end
399399

400-
defp impl_format_reason(reason) do
400+
defp impl_format_error(reason) do
401401
Exception.format_exit(reason)
402402
end
403403
end

lib/elixir/lib/kernel/cli.ex

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -281,7 +281,7 @@ defmodule Kernel.CLI do
281281
case Application.ensure_all_started(binary_to_atom(app)) do
282282
{:error, {app, reason}} ->
283283
{:error, "--app : Could not start application #{app}: " <>
284-
Application.format_reason(reason)}
284+
Application.format_error(reason)}
285285
{:ok, _} ->
286286
:ok
287287
end

lib/mix/lib/mix/tasks/app.start.ex

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ defmodule Mix.Tasks.App.Start do
3838
{:ok, _} -> :ok
3939
{:error, {app, reason}} ->
4040
raise Mix.Error, message: "Could not start application #{app}: " <>
41-
Application.format_reason(reason)
41+
Application.format_error(reason)
4242
end
4343
else
4444
:error

lib/mix/lib/mix/tasks/escriptize.ex

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -183,7 +183,7 @@ defmodule Mix.Tasks.Escriptize do
183183
{:ok, _} -> :ok
184184
{:error, {app, reason}} ->
185185
io_error "Could not start application #{app}: " <>
186-
Application.format_reason(reason)
186+
Application.format_error(reason)
187187
System.halt(1)
188188
end
189189
end

0 commit comments

Comments
 (0)