Merge pull request #1980 from jwarwick/doc_typos

Fixing doc typos in ExUnit and Kernel.Typespec

Author: ericmj

lib/elixir/lib/kernel/typespec.ex

@@ -21,9 +21,9 @@ defmodule Kernel.Typespec do
   expressed the same way: `pid()` or simply `pid`. Parametrized types are also
   supported (`list(integer`) and so are remote types (`Enum.t`).
 
-  For integers and atoms literals are allowed as types (ex. `1`, `:atom` or
-  `false`). All other types are built up of unions of predefined types. Certain
-  shorthands are allowed, such as `[...]`, `<<>>` and `{...}`).
+  Integers and atom literals are allowed as types (ex. `1`, `:atom` or
+  `false`). All other types are built of unions of predefined types. Certain
+  shorthands are allowed, such as `[...]`, `<<>>` and `{...}`.
 
   ### Predefined types
 
@@ -57,17 +57,17 @@ defmodule Kernel.Typespec do
 
       Integer :: integer
                | ElixirInteger                # ..., -1, 0, 1, ... 42 ...
-               | ElixirInteger..ElixirInteger # specifies an integer range
+               | ElixirInteger..ElixirInteger # an integer range
 
       List :: list(Type)                        # proper list ([]-terminated)
             | improper_list(Type1, Type2)       # Type1=contents, Type2=termination
             | maybe_improper_list(Type1, Type2) # Type1 and Type2 as above
             | nonempty_list(Type)               # proper non-empty list
             | []                                # empty list
             | [Type]                            # shorthand for list(Type)
-            | [Type, ...]                       # sharthand for nonempty_list(Type)
+            | [Type, ...]                       # shorthand for nonempty_list(Type)
 
-      Tuple :: tuple     # stands for a tuple of any size
+      Tuple :: tuple     # a tuple of any size
              | {}        # empty tuple
              | { TList }
 
@@ -185,13 +185,13 @@ defmodule Kernel.Typespec do
   use the `char_list` type which is a synonym for `string`. If you use `string`,
   you'll get a warning from the compiler.
 
-  If you want to refer to the "string" type (the one operated by functions in
-  the String module), use `String.t` type instead.
+  If you want to refer to the "string" type (the one operated on by functions in
+  the `String` module), use `String.t` type instead.
   """
 
   @doc """
   Defines a type.
-  This macro is the one responsible for handling the attribute `@type`.
+  This macro is responsible for handling the attribute `@type`.
 
   ## Examples
 
@@ -206,7 +206,7 @@ defmodule Kernel.Typespec do
 
   @doc """
   Defines an opaque type.
-  This macro is the one responsible for handling the attribute `@opaque`.
+  This macro is responsible for handling the attribute `@opaque`.
 
   ## Examples
 
@@ -221,7 +221,7 @@ defmodule Kernel.Typespec do
 
   @doc """
   Defines a private type.
-  This macro is the one responsible for handling the attribute `@typep`.
+  This macro is responsible for handling the attribute `@typep`.
 
   ## Examples
 
@@ -236,7 +236,7 @@ defmodule Kernel.Typespec do
 
   @doc """
   Defines a spec.
-  This macro is the one responsible for handling the attribute `@spec`.
+  This macro is responsible for handling the attribute `@spec`.
 
   ## Examples
 
@@ -251,7 +251,7 @@ defmodule Kernel.Typespec do
 
   @doc """
   Defines a callback.
-  This macro is the one responsible for handling the attribute `@callback`.
+  This macro is responsible for handling the attribute `@callback`.
 
   ## Examples
 
@@ -408,10 +408,10 @@ defmodule Kernel.Typespec do
   @doc """
   Returns all type docs available from the module's beam code.
 
-  It is returned as a list of tuples where the first element is the pair of type
+  The result is returned as a list of tuples where the first element is the pair of type
   name and arity and the second element is the documentation.
 
-  The module has to have a corresponding beam file on the disk which can be
+  The module must have a corresponding beam file which can be
   located by the runtime system.
   """
   @spec beam_typedocs(module | binary) :: [tuple] | nil
@@ -428,10 +428,10 @@ defmodule Kernel.Typespec do
   @doc """
   Returns all types available from the module's beam code.
 
-  It is returned as a list of tuples where the first
+  The result is returned as a list of tuples where the first
   element is the type (`:typep`, `:type` and `:opaque`).
 
-  The module has to have a corresponding beam file on the disk which can be
+  The module must have a corresponding beam file which can be
   located by the runtime system.
   """
   @spec beam_types(module | binary) :: [tuple] | nil
@@ -456,10 +456,10 @@ defmodule Kernel.Typespec do
   @doc """
   Returns all specs available from the module's beam code.
 
-  It is returned as a list of tuples where the first
+  The result is returned as a list of tuples where the first
   element is spec name and arity and the second is the spec.
 
-  The module has to have a corresponding beam file on the disk which can be
+  The module must have a corresponding beam file which can be
   located by the runtime system.
   """
   @spec beam_specs(module | binary) :: [tuple] | nil
@@ -470,10 +470,10 @@ defmodule Kernel.Typespec do
   @doc """
   Returns all callbacks available from the module's beam code.
 
-  It is returned as a list of tuples where the first
+  The result is returned as a list of tuples where the first
   element is spec name and arity and the second is the spec.
 
-  The module has to have a corresponding beam file on the disk
+  The module must have a corresponding beam file 
   which can be located by the runtime system.
   """
   @spec beam_callbacks(module | binary) :: [tuple] | nil

lib/ex_unit/lib/ex_unit/callbacks.ex

@@ -30,7 +30,7 @@ defmodule ExUnit.Callbacks do
   be called sequentially. In the case of `setup_all` and `teardown_all` callbacks,
   each `setup_all` will be called only once before the first test's `setup` and each
   `teardown_all` will be called once after the last test. No callback runs if the
-  test case has no tests or all tests were fltered out via include/exclude.
+  test case has no tests or all tests were filtered out via `include`/`exclude`.
 
   ## Examples
 
@@ -41,7 +41,7 @@ defmodule ExUnit.Callbacks do
         setup do
           IO.puts "This is a setup callback"
 
-          # Return extra metadata, it has to be a keyword list
+          # Return extra metadata, it must be a keyword list
           { :ok, [hello: "world"] }
         end
 

lib/ex_unit/lib/ex_unit/case.ex

@@ -85,10 +85,10 @@ defmodule ExUnit.Case do
       end
 
   In the example above, we have defined a tag called `:cd` that is
-  read in callbacks to configure the working directory the test is
+  read in the setup callback to configure the working directory the test is
   going to run on. We then use the same context to store the
   previous working directory that is reverted to after the test
-  in a teardown callback.
+  in the teardown callback.
 
   Tags are also very effective when used with case templates
   (`ExUnit.CaseTemplate`) allowing callbacks in the case template
@@ -108,7 +108,7 @@ defmodule ExUnit.Case do
       @moduletag :external
 
   If the same key is set via `@tag`, the `@tag` value has higher
-  preference.
+  precedence.
 
   ### Reserved tags
 
@@ -117,7 +117,7 @@ defmodule ExUnit.Case do
 
   * `:case` - the test case module
   * `:test` - the test name
-  * `:line` - the line the test was defined
+  * `:line` - the line on which the test was defined
 
   ## Filters
 
@@ -128,31 +128,31 @@ defmodule ExUnit.Case do
       # Exclude all external tests from running
       ExUnit.configure exclude: [external: true]
 
-  From now on, ExUnit will not run any test that has the external flag set to true.
+  From now on, ExUnit will not run any test that has the `external` flag set to true.
   This behaviour can be reversed with the `:include` option which is usually passed
   through the command line:
 
       mix test --include external:true
 
-  The command above will have override exclude configuration, running all tests,
-  including the ones that have the external flag set to true.
+  The command above will override the excluded configuration, running all tests,
+  including the ones that have the `external` flag set to true.
 
-  Another use case for using tags and filters is to exclude all tests that have
+  Another use case for tags and filters is to exclude all tests that have
   a particular tag by default, regardless of its value, and include only a certain
   subset:
 
       ExUnit.configure exclude: :os, include: [os: :unix]
 
   Keep in mind that all tests are included by default, so unless they are
-  excluded first, the include option has no effect.
+  excluded first, the `include` option has no effect.
   """
 
   @doc false
   defmacro __using__(opts) do
     async = Keyword.get(opts, :async, false)
 
     unless Process.whereis(ExUnit.Server) do
-      raise "cannot use ExUnit.Case without starting ExUnit application, " <>
+      raise "cannot use ExUnit.Case without starting the ExUnit application, " <>
             "please call ExUnit.start() or explicitly start the :ex_unit app"
     end
 
@@ -186,7 +186,7 @@ defmodule ExUnit.Case do
   Provides a convenient macro that allows a test to be
   defined with a string. This macro automatically inserts
   the atom `:ok` as the last line of the test. That said,
-  a passing test always returns `:ok`, but, more important,
+  a passing test always returns `:ok`, but, more importantly,
   it forces Elixir to not tail call optimize the test and
   therefore avoids hiding lines from the backtrace.