General corrections (#7870)

* Modules/types are mentioned in singular, not plural

* General improvements in the documentation

Author: eksperimental

lib/elixir/lib/agent.ex

@@ -77,7 +77,7 @@ defmodule Agent do
   defined module to be put under a supervision tree. The generated
   `child_spec/1` can be customized with the following options:
 
-    * `:id` - the child specification id, defaults to the current module
+    * `:id` - the child specification identifier, defaults to the current module
     * `:start` - how to start the child process (defaults to calling `__MODULE__.start_link/1`)
     * `:restart` - when the child should be restarted, defaults to `:permanent`
     * `:shutdown` - how to shut down the child

lib/elixir/lib/gen_server.ex

@@ -120,7 +120,7 @@ defmodule GenServer do
   defined module to be put under a supervision tree. The generated
   `child_spec/1` can be customized with the following options:
 
-    * `:id` - the child specification id, defaults to the current module
+    * `:id` - the child specification identifier, defaults to the current module
     * `:start` - how to start the child process (defaults to calling `__MODULE__.start_link/1`)
     * `:restart` - when the child should be restarted, defaults to `:permanent`
     * `:shutdown` - how to shut down the child
@@ -161,11 +161,11 @@ defmodule GenServer do
       GenServer.call(MyStack, :pop) #=> :hello
 
   Once the server is started, the remaining functions in this module (`call/3`,
-  `cast/2`, and friends) will also accept an atom, or any `:global` or `:via`
-  tuples. In general, the following formats are supported:
+  `cast/2`, and friends) will also accept an atom, or any `{:global, ...}` or
+  `{:via, ...}` tuples. In general, the following formats are supported:
 
-    * a `pid`
-    * an `atom` if the server is locally registered
+    * a PID
+    * an atom if the server is locally registered
     * `{atom, node}` if the server is locally registered at another node
     * `{:global, term}` if the server is globally registered
     * `{:via, module, name}` if the server is registered through an alternative
@@ -558,7 +558,7 @@ defmodule GenServer do
   exits. For such reasons, we usually recommend important clean-up rules to
   happen in separated processes either by use of monitoring or by links
   themselves. There is no cleanup needed when the `GenServer` controls a `port` (e.g.
-  `:gen_tcp.socket`) or `t:File.io_device/0`, because these will be closed on 
+  `:gen_tcp.socket`) or `t:File.io_device/0`, because these will be closed on
   receiving a `GenServer`'s exit signal and do not need to be closed manually
   in `c:terminate/2`.
 

lib/elixir/lib/io/ansi/docs.ex

@@ -14,7 +14,7 @@ defmodule IO.ANSI.Docs do
     * `:doc_code`          - code blocks (cyan)
     * `:doc_headings`      - h1, h2, h3, h4, h5, h6 headings (yellow)
     * `:doc_inline_code`   - inline code (cyan)
-    * `:doc_table_heading` - style for table headings
+    * `:doc_table_heading` - the style for table headings
     * `:doc_title`         - top level heading (reverse, yellow)
     * `:doc_underline`     - underlined text (underline)
     * `:width`             - the width to format the text (80)

lib/elixir/lib/kernel.ex

@@ -59,7 +59,7 @@ defmodule Kernel do
 
   There are two data types without an accompanying module:
 
-    * Bitstrings - a sequence of bits, created with `Kernel.SpecialForms.<<>>/1`.
+    * Bitstring - a sequence of bits, created with `Kernel.SpecialForms.<<>>/1`.
       When the number of bits is divisible by 8, they are called binaries and can
       be manipulated with Erlang's `:binary` module
     * Reference - a unique value in the runtime system, created with `make_ref/0`
@@ -4969,7 +4969,7 @@ defmodule Kernel do
   @doc ~S"""
   Handles the sigil `~c` for charlists.
 
-  It returns a charlist as if it were a single quoted string, unescaping
+  It returns a charlist as if it was a single quoted string, unescaping
   characters and replacing interpolations.
 
   ## Examples

lib/elixir/lib/task.ex

@@ -96,7 +96,7 @@ defmodule Task do
   defined module to be put under a supervision tree. The generated
   `child_spec/1` can be customized with the following options:
 
-    * `:id` - the child specification id, defaults to the current module
+    * `:id` - the child specification identifier, defaults to the current module
     * `:start` - how to start the child process (defaults to calling `__MODULE__.start_link/1`)
     * `:restart` - when the child should be restarted, defaults to `:temporary`
     * `:shutdown` - how to shut down the child

lib/elixir/pages/Compatibility and Deprecations.md

@@ -16,7 +16,7 @@ Elixir version | Support
 
 Major Elixir releases may contain breaking changes and those will be explicitly outlined in the CHANGELOG. There are currently no plans for a major v2 release.
 
-## Compatibility between Elixir non-major versions
+## Compatibility between non-major Elixir versions
 
 Elixir minor and patch releases are backwards compatible: well-defined behaviours and documented APIs in a given version will continue working on future versions.
 

lib/ex_unit/lib/ex_unit/doc_test.ex

@@ -165,7 +165,7 @@ defmodule ExUnit.DocTest do
   This macro is used to generate ExUnit test cases for doctests.
 
   Calling `doctest(Module)` will generate tests for all doctests found
-  in the module `Module`
+  in the `module`.
 
   Options can also be given:
 
@@ -187,7 +187,7 @@ defmodule ExUnit.DocTest do
 
   This macro is auto-imported with every `ExUnit.Case`.
   """
-  defmacro doctest(mod, opts \\ []) do
+  defmacro doctest(module, opts \\ []) do
     require =
       if is_atom(Macro.expand(mod, __CALLER__)) do
         quote do

lib/iex/lib/iex/helpers.ex

@@ -1067,7 +1067,7 @@ defmodule IEx.Helpers do
   end
 
   @doc """
-  Evaluates the contents of the file at `path` as if it were directly typed into
+  Evaluates the contents of the file at `path` as if it was directly typed into
   the shell.
 
   `path` has to be a literal string. `path` is automatically expanded via

lib/logger/lib/logger.ex

@@ -280,7 +280,7 @@ defmodule Logger do
 
     * `:line` - the current line
 
-    * `:pid` - the current process ID
+    * `:pid` - the current process identifier
 
     * `:crash_reason` - a two-element tuple with the throw/error/exit reason
       as first argument and the stacktrace as second. A throw will always be

lib/logger/lib/logger/formatter.ex

@@ -15,8 +15,8 @@ defmodule Logger.Formatter do
 
   The valid parameters you can use are:
 
-    * `$time`     - time the log message was sent
-    * `$date`     - date the log message was sent
+    * `$time`     - the time the log message was sent
+    * `$date`     - the date the log message was sent
     * `$message`  - the log message
     * `$level`    - the log level
     * `$node`     - the node that prints the message