Skip to content

Commit 394ccb3

Browse files
committed
Fixed doc typos in Mix.Tasks.Deps.*
1 parent e7c0a2a commit 394ccb3

File tree

6 files changed

+16
-16
lines changed

6 files changed

+16
-16
lines changed

lib/mix/lib/mix/tasks/deps.check.ex

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@ defmodule Mix.Tasks.Deps.Check do
44
import Mix.Deps, only: [all: 0, format_dep: 1, format_status: 1, check_lock: 2, out_of_date?: 1]
55

66
@hidden true
7-
@shortdoc "Check if all dependencies are ok"
7+
@shortdoc "Check if all dependencies are valid"
88
@recursive :both
99

1010
@moduledoc """
1111
Checks if all dependencies are valid and if not, abort.
12-
Prints the invalid dependencies status before aborting.
12+
Prints the invalid dependencies' status before aborting.
1313
1414
This task is not shown in `mix help` but it is part
15-
of mix public API and can be depended on.
15+
of the `mix` public API and can be depended on.
1616
"""
1717
def run(_) do
1818
lock = Mix.Deps.Lock.read

lib/mix/lib/mix/tasks/deps.clean.ex

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
defmodule Mix.Tasks.Deps.Clean do
22
use Mix.Task
33

4-
@shortdoc "Remove dependencies files"
4+
@shortdoc "Remove dependencies' files"
55
@recursive :both
66

77
@moduledoc """
88
Clean dependencies.
99
10-
By default, cleans all dependencies. A list of deps can
10+
By default, cleans all dependencies. A list of dependencies can
1111
be given to clean specific ones. Clean does not unlock
12-
the repositories, unless --unlock is given.
12+
the repositories, unless `--unlock` is given.
1313
"""
1414

1515
import Mix.Deps, only: [all: 0, by_name: 1, format_dep: 1]

lib/mix/lib/mix/tasks/deps.compile.ex

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,10 @@ defmodule Mix.Tasks.Deps.Compile do
77
@moduledoc """
88
Compile dependencies.
99
10-
By default, compile all dependencies. A list of deps can
11-
be given to force the compilation of specific deps.
10+
By default, compile all dependencies. A list of dependencies can
11+
be given to force the compilation of specific dependencies.
1212
13-
By default, it tries to detect if the project contains one of
13+
By default, attempt to detect if the project contains one of
1414
the following files:
1515
1616
* `mix.exs` - if so, invokes `mix compile`
@@ -97,7 +97,7 @@ defmodule Mix.Tasks.Deps.Compile do
9797
catch
9898
kind, reason ->
9999
Mix.shell.error "could not compile dependency #{app}, mix compile failed. " <>
100-
"In case you want to recompile this dependency, please run: mix deps.compile #{app}"
100+
"If you want to recompile this dependency, please run: mix deps.compile #{app}"
101101
:erlang.raise(kind, reason, System.stacktrace)
102102
after
103103
Mix.env(old_env)
@@ -129,7 +129,7 @@ defmodule Mix.Tasks.Deps.Compile do
129129
defp do_command(app, command, extra // "") do
130130
if Mix.shell.cmd("#{command} #{extra}") != 0 do
131131
raise Mix.Error, message: "could not compile dependency #{app}, #{command} command failed. " <>
132-
"In case you want to recompile this dependency, please run: mix deps.compile #{app}"
132+
"If you want to recompile this dependency, please run: mix deps.compile #{app}"
133133
end
134134
end
135135

@@ -141,7 +141,7 @@ defmodule Mix.Tasks.Deps.Compile do
141141
Mix.shell.info("#{app}: #{command}")
142142
if Mix.shell.cmd(command) != 0 do
143143
raise Mix.Error, message: "could not compile dependency #{app}, custom #{command} command failed. " <>
144-
"In case you want to recompile this dependency, please run: mix deps.compile #{app}"
144+
"If you want to recompile this dependency, please run: mix deps.compile #{app}"
145145
end
146146
end
147147
end

lib/mix/lib/mix/tasks/deps.ex

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ defmodule Mix.Tasks.Deps do
88

99
@moduledoc """
1010
List all dependencies and their status.
11-
The output is given as follow:
11+
The output is given as follows:
1212
1313
* APP [VERSION] SCM: LOCATION
1414
[locked at REF]

lib/mix/lib/mix/tasks/deps.loadpaths.ex

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@ defmodule Mix.Tasks.Deps.Loadpaths do
44
import Mix.Deps, only: [all: 0, load_paths: 1, ok?: 1]
55

66
@hidden true
7-
@shortdoc "Load all dependencies paths"
7+
@shortdoc "Load all dependencies' paths"
88
@recursive :both
99

1010
@moduledoc """
1111
Loads all dependencies. This is invoked directly
12-
by "loadpaths" when the CLI boots.
12+
by `loadpaths` when the CLI boots.
1313
"""
1414
def run(args) do
1515
{ opts, _ } = OptionParser.parse(args)

lib/mix/lib/mix/tasks/deps.update.ex

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ defmodule Mix.Tasks.Deps.Update do
77
@moduledoc """
88
Update dependencies.
99
10-
By default, updates all dependencies. A list of deps can
10+
By default, updates all dependencies. A list of dependencies can
1111
be given to update specific ones. Recompiles the given
1212
projects after updating.
1313

0 commit comments

Comments
 (0)