Merge pull request #3730 from eksperimental/mix_help

Several standardization fixes

Author: josevalim

lib/elixir/lib/agent.ex

@@ -34,7 +34,7 @@ defmodule Agent do
           Agent.update(__MODULE__, &Set.put(&1, item))
         end
 
-        @doc "Reset the executed tasks and return the previous list of tasks"
+        @doc "Resets the executed tasks and return the previous list of tasks"
         def take_all() do
           Agent.get_and_update(__MODULE__, fn set ->
             {Enum.into(set, []), HashSet.new}

lib/elixir/lib/gen_server.ex

@@ -385,7 +385,7 @@ defmodule GenServer do
                   {:timeout, timeout} |
                   {:spawn_opt, Process.spawn_opt}
 
-  @typedoc "debug options supported by the `start*` functions"
+  @typedoc "Debug options supported by the `start*` functions"
   @type debug :: [:trace | :log | :statistics | {:log_to_file, Path.t}]
 
   @typedoc "The server reference"

lib/elixir/lib/io/ansi.ex

@@ -51,7 +51,7 @@ defmodule IO.ANSI do
   @doc "Faint (decreased intensity), not widely supported"
   defsequence :faint, 2
 
-  @doc "Italic: on. Not widely supported. Sometimes treated as inverse."
+  @doc "Italic: on. Not widely supported. Sometimes treated as inverse"
   defsequence :italic, 3
 
   @doc "Underline: Single"
@@ -72,7 +72,7 @@ defmodule IO.ANSI do
   @doc "Conceal. Not widely supported"
   defsequence :conceal, 8
 
-  @doc "Crossed-out. Characters legible, but marked for deletion. Not widely supported."
+  @doc "Crossed-out. Characters legible, but marked for deletion. Not widely supported"
   defsequence :crossed_out, 9
 
   @doc "Sets primary (default) font"
@@ -126,10 +126,10 @@ defmodule IO.ANSI do
   @doc "Not overlined"
   defsequence :not_overlined, 55
 
-  @doc "Send cursor home"
+  @doc "Sends cursor home"
   defsequence :home, "", "H"
 
-  @doc "Clear screen"
+  @doc "Clears screen"
   defsequence :clear, "2", "J"
 
   defp format_sequence(other) do

lib/mix/lib/mix/dep.ex

@@ -2,7 +2,8 @@ defmodule Mix.Dep do
   @moduledoc false
 
   @doc """
-  The Mix.Dep a struct keeps information about your project dependencies.
+  The Mix.Dep struct keeps information about your project dependencies.
+
   It contains:
 
     * `scm` - a module representing the source code management tool (SCM)

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

@@ -1,20 +1,20 @@
 defmodule Mix.Tasks.Deps.Clean do
   use Mix.Task
 
-  @shortdoc "Removes the given dependencies' files"
+  @shortdoc "Deletes the given dependencies' files"
 
   @moduledoc """
-  Removes the given dependencies' files, including build artifacts and fetched
+  Deletes the given dependencies' files, including build artifacts and fetched
   sources.
 
   Since this is a destructive action, cleaning of dependencies
   can only happen by passing arguments/options:
 
-    * `dep1, dep2` - the name of dependencies to be removed
-    * `--all` - removes all dependencies
-    * `--unused` - removes only unused dependencies (no longer mentioned
+    * `dep1, dep2` - the name of dependencies to be deleted
+    * `--all`      - deletes all dependencies
+    * `--unused`   - deletes only unused dependencies (no longer mentioned
       in the `mix.exs` file)
-    * `--unlock` - also unlock the removed dependencies
+    * `--unlock`   - also unlocks the deleted dependencies
 
   By default this task works across all environments, unless `--only`
   is given.