Skip to content

Commit 934b47f

Browse files
committed
Fixed doc typos in Macro
1 parent ff0304c commit 934b47f

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

lib/elixir/lib/macro.ex

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ defmodule Macro do
3232
a valid call syntax.
3333
3434
This is useful for macros that want to provide the same
35-
arguments syntax available in def/defp/defmacro and friends.
35+
argument syntax available in def/defp/defmacro and friends.
3636
3737
## Examples
3838
@@ -50,7 +50,7 @@ defmodule Macro do
5050
Recursively escapes a value so it can be inserted
5151
into a syntax tree.
5252
53-
One may pass `unquote: true` to `Macro.escape/2`
53+
One may pass `unquote: true` to `escape/2`
5454
which leaves unquote statements unescaped, effectively
5555
unquoting the contents on escape.
5656
@@ -118,7 +118,7 @@ defmodule Macro do
118118
def unescape_map(?v), do: ?\v
119119
def unescape_map(e), do: e
120120
121-
If the `unescape_map` function returns false. The char is
121+
If the `unescape_map` function returns `false`. The char is
122122
not escaped and `\` is kept in the char list.
123123
124124
## Octals
@@ -128,7 +128,7 @@ defmodule Macro do
128128
129129
## Hex
130130
131-
Octals will by default be escaped unless the map function
131+
Hexadecimals will by default be escaped unless the map function
132132
returns false for ?x.
133133
134134
## Examples
@@ -354,13 +354,13 @@ defmodule Macro do
354354
355355
* Macros (local or remote);
356356
* Aliases are expanded (if possible) and return atoms;
357-
* All pseudo-variables (__FILE__, __MODULE__, etc);
358-
* Module attributes reader (@foo);
357+
* All pseudo-variables (`__FILE__`, `__MODULE__`, etc);
358+
* Module attributes reader (`@foo`);
359359
360360
In case the expression cannot be expanded, it returns the expression
361-
itself. Notice that `Macro.expand_once/2` performs the expansion just
362-
once and it is not recursive. Check `Macro.expand/2` for expansion
363-
until the node no longer represents a macro and `Macro.expand_all/2`
361+
itself. Notice that `expand_once/2` performs the expansion just
362+
once and it is not recursive. Check `expand/2` for expansion
363+
until the node no longer represents a macro and `expand_all/2`
364364
for recursive expansion.
365365
366366
## Examples
@@ -523,8 +523,8 @@ defmodule Macro do
523523

524524
@doc """
525525
Receives a AST node and expands it until it no longer represents
526-
a macro. Check `Macro.expand_once/2` for more information on how
527-
expansion works and `Macro.expand_all/2` for recursive expansion.
526+
a macro. Check `expand_once/2` for more information on how
527+
expansion works and `expand_all/2` for recursive expansion.
528528
"""
529529
def expand(tree, env) do
530530
expand(tree, env, nil) |> elem(0)
@@ -547,16 +547,16 @@ defmodule Macro do
547547
Receives a AST node and expands it until it no longer represents
548548
a macro. Then it expands all of its children recursively.
549549
550-
The documentation for `Macro.expand_once/2` goes into more detail
551-
on how expansion works. Keep in mind that `Macro.expand_all/2` is
550+
The documentation for `expand_once/2` goes into more detail
551+
on how expansion works. Keep in mind that `expand_all/2` is
552552
naive as it doesn't mutate the environment. Take this example:
553553
554554
quoted = quote do: __MODULE__
555555
Macro.to_string Macro.expand_all(quoted, __ENV__)
556556
#=> "nil"
557557
558558
The example above, works as expected. Outside of a module,
559-
`__MODULE__` returns nil. Now consider this variation:
559+
`__MODULE__` returns `nil`. Now consider this variation:
560560
561561
quoted = quote do
562562
defmodule Foo, do: __MODULE__
@@ -601,8 +601,8 @@ defmodule Macro do
601601
end
602602

603603
@doc """
604-
Recurs the quoted expression checking if all sub terms are
605-
safe (i.e. they represented data structured and don't actually
604+
Recurs the quoted expression checking if all sub-terms are
605+
safe (i.e. they represent data structures and don't actually
606606
evaluate code) and returns `:ok` unless a given term is unsafe,
607607
which is returned as `{ :unsafe, term }`.
608608
"""

0 commit comments

Comments
 (0)