Skip to content

Commit d4d8240

Browse files
author
José Valim
committed
Update docs for Record.import/2
1 parent c628455 commit d4d8240

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

Diff for: lib/elixir/lib/record.ex

+6-6
Original file line numberDiff line numberDiff line change
@@ -225,11 +225,10 @@ defmodule Record do
225225
end
226226
227227
@doc """
228-
Import public record definition as a set of private macros (as defined by defrecordp/2)
229-
230-
## Usage
231-
232-
Record.import Record.Module, as: macro_name
228+
Import public record definition as a set of private macros,
229+
as defined by `Kernel.defrecordp/2`. This is useful when one
230+
desires to manipulate a record via a set of macros instead
231+
of the regular access syntax.
233232

234233
## Example
235234

@@ -242,7 +241,8 @@ defmodule Record do
242241
"""
243242
defmacro import(module, as: name) do
244243
quote do
245-
Record.defmacros(unquote(name), unquote(module).__record__(:fields), __ENV__, unquote(module))
244+
Record.defmacros(unquote(name),
245+
unquote(module).__record__(:fields), __ENV__, unquote(module))
246246
end
247247
end
248248

0 commit comments

Comments
 (0)