Fixed typos in Mix.Deps. Updated error strings in test cases

Author: jwarwick

lib/mix/lib/mix/deps.ex

@@ -2,18 +2,18 @@ defrecord Mix.Dep, [ scm: nil, app: nil, requirement: nil, status: nil, opts: ni
                      deps: [], source: nil, manager: nil, from: nil ] do
   @moduledoc """
   This is a record that keeps information about your project
-  dependencies. It keeps:
-
-  * scm - a module representing the source code management tool (SCM) operations;
-  * app - the app name as an atom;
-  * requirement - a binary or regex with the dep's requirement
-  * status - the current status of dependency, check `Mix.Deps.format_status/1` for more info;
-  * opts - the options given by the developer
-  * deps - dependencies of this dependency
-  * source - any possible configuration associated with the manager field,
-      rebar.config for rebar or the Mix.Project for Mix
-  * manager - the project management, possible values: :rebar | :mix | :make | nil
-  * from - path to file where dependency was defined
+  dependencies. It contains:
+
+  * `scm` - a module representing the source code management tool (SCM) operations;
+  * `app` - the application name as an atom;
+  * `requirement` - a binary or regex with the dependency's requirement
+  * `status` - the current status of the dependency, check `Mix.Deps.format_status/1` for more info;
+  * `opts` - the options given by the developer
+  * `deps` - dependencies of this dependency
+  * `source` - any possible configuration associated with the `manager` field,
+      `rebar.config` for rebar or the `Mix.Project` for Mix
+  * `manager` - the project management, possible values: `:rebar` | `:mix` | `:make` | `nil`
+  * `from` - path to the file where the dependency was defined
   """
 end
 
@@ -23,20 +23,20 @@ defmodule Mix.Deps do
   """
 
   @doc """
-  Returns all dependencies recursively as `Mix.Dep` record.
+  Return all dependencies recursively as a `Mix.Dep` record.
 
   ## Exceptions
 
-  This function raises an exception in case the developer
-  provides a dependency in the wrong format.
+  This function raises an exception if the provided
+  dependency is in the wrong format.
   """
   def all do
     { deps, _ } = Mix.Deps.Converger.all(nil, fn(dep, acc) -> { dep, acc } end)
     deps
   end
 
   @doc """
-  Returns all dependencies but with a custom callback and
+  Return all dependencies, but with a custom callback and
   accumulator.
   """
   def all(acc, callback) do
@@ -45,12 +45,12 @@ defmodule Mix.Deps do
   end
 
   @doc """
-  Returns all direct child dependencies.
+  Return all direct child dependencies.
   """
   defdelegate children(), to: Mix.Deps.Retriever
 
   @doc """
-  Returns all dependencies depending on given dependencies.
+  Return all dependencies depending on the given dependencies.
   """
   def depending(deps, all_deps // all)
 
@@ -69,7 +69,7 @@ defmodule Mix.Deps do
   end
 
   @doc """
-  Receives a list of deps names and returns deps records.
+  Receives a list of dependency names and returns dependency records.
   Logs a message if the dependency could not be found.
   """
   def by_name(given, all_deps // all) do
@@ -93,9 +93,9 @@ defmodule Mix.Deps do
   end
 
   @doc """
-  Runs the given `fun` inside the given dependency project by
+  Run the given `fun` inside the given dependency project by
   changing the current working directory and loading the given
-  project into the project stack.
+  project onto the project stack.
   """
   def in_dependency(dep, post_config // [], fun)
 
@@ -123,13 +123,13 @@ defmodule Mix.Deps do
   end
 
   @doc """
-  Formats the status of a dependency.
+  Format the status of a dependency.
   """
   def format_status(Mix.Dep[status: { :ok, _vsn }]),
     do: "ok"
 
   def format_status(Mix.Dep[status: { :noappfile, path }]),
-    do: "could not find app file at #{Mix.Utils.relative_to_cwd(path)}"
+    do: "could not find an app file at #{Mix.Utils.relative_to_cwd(path)}"
 
   def format_status(Mix.Dep[status: { :invalidapp, path }]),
     do: "the app file at #{Mix.Utils.relative_to_cwd(path)} is invalid"
@@ -160,7 +160,7 @@ defmodule Mix.Deps do
     do: "the dependency is not available, run `mix deps.get`"
 
   @doc """
-  Checks the lock for the given dependency and update its status accordingly.
+  Check the lock for the given dependency and update its status accordingly.
   """
   def check_lock(Mix.Dep[scm: scm, app: app, opts: opts] = dep, lock) do
     if available?(dep) do
@@ -179,7 +179,7 @@ defmodule Mix.Deps do
   end
 
   @doc """
-  Updates the dependency inside the given project.
+  Update the dependency inside the given project.
   """
   defdelegate update(dep), to: Mix.Deps.Retriever
 
@@ -205,7 +205,7 @@ defmodule Mix.Deps do
   end
 
   @doc """
-  Check if a dependency is out of date or not, considering its
+  Check if a dependency is out of date, considering its
   lock status. Therefore, be sure to call `check_lock` before
   invoking this function.
   """
@@ -214,7 +214,7 @@ defmodule Mix.Deps do
   def out_of_date?(dep),                                   do: not available?(dep)
 
   @doc """
-  Format the dependency for printing.
+  Format a dependency for printing.
   """
   def format_dep(Mix.Dep[scm: scm, app: app, status: status, opts: opts]) do
     version =
@@ -227,7 +227,7 @@ defmodule Mix.Deps do
   end
 
   @doc """
-  Returns all compile paths for the dependency.
+  Return all compile paths for the dependency.
   """
   def compile_paths(Mix.Dep[app: app, opts: opts, manager: manager]) do
     if manager == :mix do
@@ -240,7 +240,7 @@ defmodule Mix.Deps do
   end
 
   @doc """
-  Returns all load paths for the dependency.
+  Return all load paths for the dependency.
   """
   def load_paths(Mix.Dep[manager: :mix, app: app, opts: opts]) do
     paths = Mix.Project.in_project app, opts[:dest], fn _ ->
@@ -267,21 +267,21 @@ defmodule Mix.Deps do
   end
 
   @doc """
-  Returns true if dependency is a mix project.
+  Return `true` if dependency is a mix project.
   """
   def mix?(Mix.Dep[manager: manager]) do
     manager == :mix
   end
 
   @doc """
-  Returns true if dependency is a rebar project.
+  Return `true` if dependency is a rebar project.
   """
   def rebar?(Mix.Dep[manager: manager]) do
     manager == :rebar
   end
 
   @doc """
-  Returns true if dependency is a make project.
+  Return `true` if dependency is a make project.
   """
   def make?(Mix.Dep[manager: manager]) do
     manager == :make

lib/mix/test/mix/tasks/deps_test.exs

@@ -65,7 +65,7 @@ defmodule Mix.Tasks.DepsTest do
       assert_received { :mix_shell, :info, ["* invalidapp [path: \"deps/invalidapp\"]"] }
       assert_received { :mix_shell, :info, ["  the app file at deps/invalidapp/ebin/invalidapp.app is invalid"] }
       assert_received { :mix_shell, :info, ["* noappfile [path: \"deps/noappfile\"]"] }
-      assert_received { :mix_shell, :info, ["  could not find app file at deps/noappfile/ebin/noappfile.app"] }
+      assert_received { :mix_shell, :info, ["  could not find an app file at deps/noappfile/ebin/noappfile.app"] }
       assert_received { :mix_shell, :info, ["* uncloned [git: \"https://github.com/elixir-lang/uncloned.git\"]"] }
       assert_received { :mix_shell, :info, ["  the dependency is not available, run `mix deps.get`"] }
     end
@@ -131,7 +131,7 @@ defmodule Mix.Tasks.DepsTest do
       assert_received { :mix_shell, :error, ["* invalidapp [path: \"deps/invalidapp\"]"] }
       assert_received { :mix_shell, :error, ["  the app file at deps/invalidapp/ebin/invalidapp.app is invalid"] }
       assert_received { :mix_shell, :error, ["* noappfile [path: \"deps/noappfile\"]"] }
-      assert_received { :mix_shell, :error, ["  could not find app file at deps/noappfile/ebin/noappfile.app"] }
+      assert_received { :mix_shell, :error, ["  could not find an app file at deps/noappfile/ebin/noappfile.app"] }
       assert_received { :mix_shell, :error, ["* uncloned [git: \"https://github.com/elixir-lang/uncloned.git\"]"] }
       assert_received { :mix_shell, :error, ["  the dependency is not available, run `mix deps.get`"] }
     end