Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation for Macro.prewalk/2 #10951

Merged
merged 2 commits into from
Apr 25, 2021
Merged

Add documentation for Macro.prewalk/2 #10951

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b34d78e
Add documentation for `Macro.prewalk/2`
iaguirre88 Apr 24, 2021
1c9412c
Update lib/elixir/lib/macro.ex
josevalim Apr 25, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions lib/elixir/lib/macro.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -490,6 +490,23 @@ defmodule Macro do

@doc """
Performs a depth-first, pre-order traversal of quoted expressions.

Returns a new ast where each node is the result of invoking `fun` on each
corresponding node of `ast`.

## Examples

iex> ast = quote do: 5 + 3 * 7
iex> new_ast = Macro.prewalk(ast, fn
...> {:+, meta, children} -> {:*, meta, children}
...> {:*, meta, children} -> {:+, meta, children}
...> other -> other
...> end)
iex> Code.eval_quoted(ast)
{26, []}
iex> Code.eval_quoted(new_ast)
{50, []}

"""
@spec prewalk(t, (t -> t)) :: t
def prewalk(ast, fun) when is_function(fun, 1) do
Expand Down