From 432f1cadf28d29c939802dc2f31e48796bf037c4 Mon Sep 17 00:00:00 2001 From: Tomasz Marek Sulima Date: Tue, 26 Dec 2017 23:58:33 +0100 Subject: [PATCH] Make options part more clear Based on discussion that was started from hpopp's comment on Elixir forum: https://elixirforum.com/t/elixir-v1-6-0-rc-0-released/11064/26?u=eiji --- lib/mix/lib/mix/tasks/format.ex | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/lib/mix/lib/mix/tasks/format.ex b/lib/mix/lib/mix/tasks/format.ex index 2453da4e51f..860c291ef17 100644 --- a/lib/mix/lib/mix/tasks/format.ex +++ b/lib/mix/lib/mix/tasks/format.ex @@ -11,11 +11,15 @@ defmodule Mix.Tasks.Format do If any of the files is `-`, then the output is read from stdin and written to stdout. + ## Formatting options + Formatting is done with the `Code.format_string!/2` function. + For complete list of formatting options please refer to its + description. A `.formatter.exs` file can also be defined for customizing input files and the formatter itself. - ## Options + ## Task-specific options * `--check-formatted` - check that the file is already formatted. This is useful in pre-commit hooks and CI scripts if you want to