diff options
author | Eksperimental <eksperimental@users.noreply.github.com> | 2018-07-11 14:58:45 +0700 |
---|---|---|
committer | José Valim <jose.valim@gmail.com> | 2018-07-11 09:58:45 +0200 |
commit | b0d8b64837efcf90d4c64efd6a45e75c3d596fd9 (patch) | |
tree | 4f9b78200ebcf31c26f9991f4fdd5afd2535b619 | |
parent | f2ff2c8c8c1fcd191c467ad11099ff2ca158fbf1 (diff) | |
download | elixir-b0d8b64837efcf90d4c64efd6a45e75c3d596fd9.tar.gz |
Be consistent in the use of present tense (#7869)
[ci skip]
-rw-r--r-- | lib/elixir/lib/kernel.ex | 2 | ||||
-rw-r--r-- | lib/mix/lib/mix/tasks/compile.ex | 2 | ||||
-rw-r--r-- | lib/mix/lib/mix/tasks/format.ex | 6 | ||||
-rw-r--r-- | lib/mix/lib/mix/tasks/profile.eprof.ex | 2 | ||||
-rw-r--r-- | lib/mix/lib/mix/tasks/xref.ex | 6 |
5 files changed, 9 insertions, 9 deletions
diff --git a/lib/elixir/lib/kernel.ex b/lib/elixir/lib/kernel.ex index 592af7c25..845f40b71 100644 --- a/lib/elixir/lib/kernel.ex +++ b/lib/elixir/lib/kernel.ex @@ -140,7 +140,7 @@ defmodule Kernel do precedence * [Syntax Reference](syntax-reference.html) - the language syntax reference * [Typespecs](typespecs.html)- types and function specifications, including list of types - * [Unicode Syntax](unicode-syntax.html) - outline Elixir support for Unicode + * [Unicode Syntax](unicode-syntax.html) - outlines Elixir support for Unicode * [Writing Documentation](writing-documentation.html) - guidelines for writing documentation in Elixir. diff --git a/lib/mix/lib/mix/tasks/compile.ex b/lib/mix/lib/mix/tasks/compile.ex index ee777b8f4..dc0a7a2c8 100644 --- a/lib/mix/lib/mix/tasks/compile.ex +++ b/lib/mix/lib/mix/tasks/compile.ex @@ -48,7 +48,7 @@ defmodule Mix.Tasks.Compile do * `--no-deps-check` - skips checking of dependencies * `--no-protocol-consolidation` - skips protocol consolidation * `--force` - forces compilation - * `--return-errors` - return error status and diagnostics instead of exiting on error + * `--return-errors` - returns error status and diagnostics instead of exiting on error * `--erl-config` - path to an Erlang term file that will be loaded as mix config """ diff --git a/lib/mix/lib/mix/tasks/format.ex b/lib/mix/lib/mix/tasks/format.ex index 6889fd6ee..537a7f4c5 100644 --- a/lib/mix/lib/mix/tasks/format.ex +++ b/lib/mix/lib/mix/tasks/format.ex @@ -50,18 +50,18 @@ defmodule Mix.Tasks.Format do ## Task-specific options - * `--check-formatted` - check that the file is already formatted. + * `--check-formatted` - checks that the file is already formatted. This is useful in pre-commit hooks and CI scripts if you want to reject contributions with unformatted code. However keep in mind that the formatted output may differ between Elixir versions as improvements and fixes are applied to the formatter. - * `--check-equivalent` - check if the files after formatting have the + * `--check-equivalent` - checks if the files after formatting have the same AST as before formatting. If the ASTs are not equivalent, it is a bug in the code formatter. This option is recommended if you are automatically formatting files. - * `--dry-run` - do not save files after formatting. + * `--dry-run` - does not save files after formatting. * `--dot-formatter` - path to the file with formatter configuration. Defaults to `.formatter.exs` if one is available. See the "`.formatter.exs`" diff --git a/lib/mix/lib/mix/tasks/profile.eprof.ex b/lib/mix/lib/mix/tasks/profile.eprof.ex index 314f2e86e..def081f9e 100644 --- a/lib/mix/lib/mix/tasks/profile.eprof.ex +++ b/lib/mix/lib/mix/tasks/profile.eprof.ex @@ -26,7 +26,7 @@ defmodule Mix.Tasks.Profile.Eprof do * `--matching` - only profile calls matching the given `Module.function/arity` pattern * `--calls` - filters out any results with a call count lower than this * `--time` - filters out any results that took lower than specified (in µs) - * `--sort` - sort the results by `time` or `calls` (default: `time`) + * `--sort` - sorts the results by `time` or `calls` (default: `time`) * `--config`, `-c` - loads the given configuration file * `--eval`, `-e` - evaluate the given code * `--require`, `-r` - requires pattern before running the command diff --git a/lib/mix/lib/mix/tasks/xref.ex b/lib/mix/lib/mix/tasks/xref.ex index 577511bc9..bd32c7eb4 100644 --- a/lib/mix/lib/mix/tasks/xref.ex +++ b/lib/mix/lib/mix/tasks/xref.ex @@ -72,7 +72,7 @@ defmodule Mix.Tasks.Xref do * `--label` - only shows relationships with the given label The labels are "compile", "struct" and "runtime" (runtime is now shown on the graph) - * `--only-nodes` - only show the node names (no edges) + * `--only-nodes` - only shows the node names (no edges) * `--source` - displays all files that the given source file references (directly or indirectly) @@ -113,9 +113,9 @@ defmodule Mix.Tasks.Xref do Those options are shared across all modes: - * `--include-siblings` - include dependencies that have `:in_umbrella` set + * `--include-siblings` - includes dependencies that have `:in_umbrella` set to true in the current project in the reports. This can be used to find - callers or analyze graphs between projects + callers or to analyze graphs between projects * `--no-compile` - does not compile even if files require compilation |