Merge pull request #3685 from eksperimental/corrections

Corrections

Author: josevalim

lib/elixir/lib/code.ex

@@ -84,7 +84,7 @@ defmodule Code do
   directories the Erlang VM uses for finding module code.
 
   The path is expanded with `Path.expand/1` before being deleted. If the
-  path does not exist it returns false.
+  path does not exist it returns `false`.
 
   ## Examples
 
@@ -341,11 +341,11 @@ defmodule Code do
 
   ## Examples
 
-  If the code is already loaded, it returns nil:
+  If the code is already loaded, it returns `nil`:
 
       Code.require_file("eex_test.exs","../eex/test") #=> nil
 
-  If the code is not already loaded, it returns the same as `load_file/2`:
+  If the code is not loaded yet, it returns the same as `load_file/2`:
 
       Code.require_file("eex_test.exs","../eex/test") |> List.first
       #=> {EExTest.Compiled, <<70, 79, 82, 49, ...>>}

lib/elixir/lib/kernel.ex

@@ -3160,7 +3160,7 @@ defmodule Kernel do
 
   For each protocol in the `@derive` list, Elixir will assert there is an
   implementation of that protocol for any (regardless if fallback to any
-  is true) and check if the any implementation defines a `__deriving__/3`
+  is `true`) and check if the any implementation defines a `__deriving__/3`
   callback. If so, the callback is invoked, otherwise an implementation
   that simply points to the any implementation is automatically derived.
 

lib/elixir/lib/string.ex

@@ -358,7 +358,7 @@ defmodule String do
 
   ## Options
 
-    * :trim - when true, does not emit empty patterns
+    * :trim - when `true`, does not emit empty patterns
   """
   @spec splitter(t, pattern, Keyword.t) :: Enumerable.t
   def splitter(string, pattern, options \\ []) do

lib/elixir/test/elixir/kernel/quote_test.exs

@@ -12,7 +12,7 @@ defmodule Kernel.QuoteTest do
   end
 
   test "keep line" do
-    ## DO NOT MOVE THIS LINE
+    # DO NOT MOVE THIS LINE
     assert quote(location: :keep, do: bar(1, 2, 3)) ==
            {:bar, [file: Path.relative_to_cwd(__ENV__.file), keep: 16], [1, 2, 3]}
   end
@@ -22,7 +22,7 @@ defmodule Kernel.QuoteTest do
   end
 
   test "quote line var" do
-    ## DO NOT MOVE THIS LINE
+    # DO NOT MOVE THIS LINE
     line = __ENV__.line
     assert quote(line: line, do: bar(1, 2, 3)) == {:bar, [line: 26], [1, 2, 3]}
   end
@@ -195,7 +195,7 @@ defmodule Kernel.QuoteTest do
   end
 end
 
-## DO NOT MOVE THIS LINE
+# DO NOT MOVE THIS LINE
 defmodule Kernel.QuoteTest.Errors do
   defmacro defadd do
     quote location: :keep do

lib/ex_unit/lib/ex_unit/formatter.ex

@@ -90,8 +90,8 @@ defmodule ExUnit.Formatter do
 
   ## Examples
 
-    iex> format_filters([run: true, slow: false], :include)
-    "Including tags: [run: true, slow: false]"
+      iex> format_filters([run: true, slow: false], :include)
+      "Including tags: [run: true, slow: false]"
 
   """
   @spec format_filters(Keyword.t, atom) :: String.t

lib/mix/lib/mix/hex.ex

@@ -3,7 +3,7 @@ defmodule Mix.Hex do
   @hex_requirement  ">= 0.5.0"
 
   @doc """
-  Returns true if Hex is loaded or installed, otherwise returns false.
+  Returns `true` if `Hex` is loaded or installed. Otherwise returns `false`.
   """
   @spec ensure_installed?(atom) :: boolean
   def ensure_installed?(app) do
@@ -22,15 +22,15 @@ defmodule Mix.Hex do
   end
 
   @doc """
-  Returns true if have required Hex, returns false if don't and don't update,
-  if update then exits.
+  Returns `true` if it has the required `Hex`. If an update is performed, it then exits.
+  Otherwise returns `false` without updating anything. 
   """
   @spec ensure_updated?() :: boolean
   def ensure_updated?() do
     cond do
-      !Code.ensure_loaded?(Hex) ->
+      not Code.ensure_loaded?(Hex) ->
         false
-      !Version.match?(Hex.version, @hex_requirement) ->
+      not Version.match?(Hex.version, @hex_requirement) ->
         Mix.shell.info "Mix requires hex #{@hex_requirement} but you have #{Hex.version}"
 
         if Mix.shell.yes?("Shall I abort the current command and update hex?") do
@@ -45,7 +45,7 @@ defmodule Mix.Hex do
   end
 
   @doc """
-  Ensures Hex is started.
+  Ensures `Hex` is started.
   """
   def start do
     try do

lib/mix/lib/mix/project.ex

@@ -370,7 +370,7 @@ defmodule Mix.Project do
   @doc """
   Ensures the project structure exists.
 
-  In case it does, it is a no-op, otherwise, it is built.
+  In case it does exist, it is a no-op. Otherwise, it is built.
   """
   def ensure_structure(config \\ config(), opts \\ []) do
     if File.exists?(app_path(config)) do

lib/mix/lib/mix/tasks/app.start.ex

@@ -7,7 +7,7 @@ defmodule Mix.Tasks.App.Start do
   Starts all registered apps.
 
   The application is started by default as temporary. In case
-  `:start_permanent` is set to true in your project configuration
+  `:start_permanent` is set to `true` in your project configuration
   or the `--permanent` flag is given, it is started as permanent,
   which guarantee the node will shutdown in case the application
   crashes permanently.

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

@@ -14,10 +14,10 @@ defmodule Mix.Tasks.Compile do
     * `:compilers` - compilers to run, defaults to:
       `[:yeec, :leex, :erlang, :elixir, :app]`
 
-    * `:consolidate_protocols` - when true, runs protocol
+    * `:consolidate_protocols` - when `true`, runs protocol
       consolidation via the `compile.protocols` task
 
-    * `:build_embedded` - when true, activates protocol
+    * `:build_embedded` - when `true`, activates protocol
       consolidation and does not generate symlinks in builds
 
   ## Command line options

lib/mix/lib/mix/tasks/profile.fprof.ex

@@ -102,15 +102,15 @@ defmodule Mix.Tasks.Profile.Fprof do
   this should give you a more correct insight into your real bottlenecks.
   Profiling with other environments might produce some false bottlenecks, such as
   protocol dispatches, which perform much faster with the `prod` environment when
-  `build_embedded` is true (which is the default for production).
+  `build_embedded` is `true` (which is the default for production).
   """
 
   @spec run(OptionParser.argv) :: :ok
   def run(args) do
     unless Mix.Project.config[:build_embedded] do
       IO.puts """
       Warning: It's advised to run this task when build_embedded is set
-      to true (usually the prod environment). Otherwise, the results may
+      to `true` (usually the prod environment). Otherwise, the results may
       contain false bottlenecks which will not appear in production.
       """
     end