Merge pull request #1397 from jwarwick/typos

Fixed doc typos in Kernel and Record

Author: José Valim

lib/elixir/lib/kernel.ex

@@ -1272,16 +1272,16 @@ defmodule Kernel do
 
   ## Nesting
 
-  Nesting a module inside the other affects its name:
+  Nesting a module inside another module affects its name:
 
       defmodule Foo do
         defmodule Bar do
         end
       end
 
-  In the example above, two modules `Foo` and `Foo.Bar`. The
+  In the example above, two modules `Foo` and `Foo.Bar` are created. The
   second can be accessed as `Bar` inside `Foo` in the same
-  lexical scope. If the module Bar is moved away to another
+  lexical scope. If the module `Bar` is moved to another
   file, it needs to be referenced via the full name or an
   alias need to be set with the help of `Kernel.SpecialForms.alias/2`.
 
@@ -1360,7 +1360,7 @@ defmodule Kernel do
 
   @doc """
   Defines a function that is private. Private functions are
-  only accessible from the same module in which they are defined.
+  only accessible from within the module in which they are defined.
 
   Check `def/2` for more information
 
@@ -1599,14 +1599,14 @@ defmodule Kernel do
       name #=> "José"
 
   By default, Elixir uses the record name as the first element of the tuple.
-  In some cases though,  this might be undesirable and one can explicitly
+  In some cases though, this might be undesirable and one can explicitly
   define what the first element of the record should be:
 
       defmodule MyServer do
         defrecordp :state, MyServer, data: nil
       end
 
-  This way, the record created will have `MyServer` as first element,
+  This way, the record created will have `MyServer` as the first element,
   not `:state`:
 
       state() #=> { MyServer, nil }
@@ -1671,10 +1671,9 @@ defmodule Kernel do
   end
 
   @doc """
-  Define elem to get Tuple element according to Elixir conventions
-  (i.e. it expects the tuple as first argument, zero-index based).
+  Get the element at the zero-based `index` in `tuple`.
 
-  It is implemented as a macro so it can be used in guards.
+  Implemented as a macro so it can be used in guards.
 
   ## Example
 
@@ -1692,8 +1691,7 @@ defmodule Kernel do
   end
 
   @doc """
-  Define set_elem to set Tuple element according to Elixir conventions
-  (i.e. it expects the tuple as first argument, zero-index based).
+  Sets the element in `tuple` at the zero-based `index` to the given `value`.
 
   ## Example
 
@@ -1711,9 +1709,7 @@ defmodule Kernel do
   end
 
   @doc """
-  Define insert_elem to insert element into a tuple according to
-  Elixir conventions (i.e. it expects the tuple as first argument,
-  zero-index based).
+  Inserts `value` into `tuple` at the given zero-based `index`.
 
   ## Example
 
@@ -1730,9 +1726,7 @@ defmodule Kernel do
   end
 
   @doc """
-  Define delete_elem to delete element from a tuple according to
-  Elixir conventions (i.e. it expects the tuple as first argument,
-  zero-index based).
+  Deletes the element at the zero-based `index` from `tuple`.
 
   Please note that in versions of Erlang prior to R16B there is no BIF
   for this operation and it is emulated by converting the tuple to a list
@@ -2737,24 +2731,24 @@ defmodule Kernel do
 
       if(foo, do: bar)
 
-  In the example above, bar will be returned if foo evaluates to
-  true (i.e. it is not false nor nil). Otherwise, nil will be returned.
+  In the example above, `bar` will be returned if `foo` evaluates to
+  `true` (i.e. it is neither `false` nor `nil`). Otherwise, `nil` will be returned.
 
-  An else option can be given to specify the opposite:
+  An `else` option can be given to specify the opposite:
 
       if(foo, do: bar, else: baz)
 
   ## Blocks examples
 
-  Elixir also allows you to pass a block to the if macro. The first
+  Elixir also allows you to pass a block to the `if` macro. The first
   example above would be translated to:
 
       if foo do
         bar
       end
 
-  Notice that do/end becomes delimiters. The second example would
-  then translate do:
+  Notice that `do/end` becomes delimiters. The second example would
+  then translate to:
 
       if foo do
         bar
@@ -3156,8 +3150,8 @@ defmodule Kernel do
   end
 
   @doc """
-  Returns true if the element on the left is equal (==) to
-  any of the items in the right.
+  Returns `true` if the element on the left is equal (==) to
+  any of the items on the right.
 
   ## Examples
 

lib/elixir/lib/record.ex

@@ -57,7 +57,7 @@ defmodule Record do
       user(sample_user, age: 26)
 
   Since `user` is a macro, all the work happens at compilation time.
-  This means all the operations, like changing the `age` above, works
+  This means all operations, like changing the `age` above, work
   as a simple tuple operation at runtime:
 
       # This update operation...
@@ -88,7 +88,7 @@ defmodule Record do
       defrecord User, name: "José", age: 25
 
   Notice that, unlike `defrecordp`, `defrecord` expects an
-  alias as first argument. This is because `defrecord` is going
+  alias as the first argument. This is because `defrecord` is going
   to create a module named `User` with all the relevant metadata.
   This module can then be imported and we can manipulate the user
   as with `defrecordp`:
@@ -99,12 +99,12 @@ defmodule Record do
 
   Notice that now, since the record definition is accessible, Elixir
   shows the record nicely formatted, no longer as a simple tuple. We
-  can get the raw formatting with by passing raw: true to inspect:
+  can get the raw formatting by passing `raw: true` to `inspect`:
 
       inspect user(), raw: true
       { User, "José", 25 }
 
-  Since working with external records is frequent, Elixir allows
+  Since working with external records is common, Elixir allows
   developers to skip importing the record altogether in favor
   of a `Module[args]` syntax:
 
@@ -199,11 +199,11 @@ defmodule Record do
 
   ## Example
 
-     defmodule Test do
-       Record.import File.Stat, as: :file_stat
+      defmodule Test do
+        Record.import File.Stat, as: :file_stat
 
-       def size(file_stat(size: size)), do: size
-     end
+        def size(file_stat(size: size)), do: size
+      end
 
   """
   defmacro import(module, as: name) do