diff options
| author | Gustavo Saiani <gustavo.saiani@toptal.com> | 2018-09-21 10:13:02 -0300 |
|---|---|---|
| committer | José Valim <jose.valim@gmail.com> | 2018-09-21 15:13:02 +0200 |
| commit | 0d449ad364e21d37045d4b46dc4da995ee93b8b1 (patch) | |
| tree | fe3db4a5434ae5736347a732cfac55f3a16154bd | |
| parent | a71f8311cb0b7bac1edbd648796afafde50193cb (diff) | |
| download | elixir-0d449ad364e21d37045d4b46dc4da995ee93b8b1.tar.gz | |
Improve Record @docs (#8212)
| -rw-r--r-- | lib/elixir/lib/record.ex | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/lib/elixir/lib/record.ex b/lib/elixir/lib/record.ex index 791352d6c..9b5f5312e 100644 --- a/lib/elixir/lib/record.ex +++ b/lib/elixir/lib/record.ex @@ -62,11 +62,11 @@ defmodule Record do * `:includes` - (a list of directories as binaries) if the record being extracted depends on relative includes, this option allows developers - to specify the directory those relative includes exist + to specify the directory where those relative includes exist. * `:macros` - (keyword list of macro names and values) if the record - being extract depends on the values of macros, this option allows - the value of those macros to be set + being extracted depends on the values of macros, this option allows + the value of those macros to be set. These options are expected to be literals (including the binary values) at compile time. @@ -112,6 +112,7 @@ defmodule Record do that contains the record definitions to extract; with this option, this function uses the same path lookup used by the `-include` attribute used in Erlang modules. + * `:from_lib` - (binary representing a path to a file) path to the Erlang file that contains the record definitions to extract; with this option, this function uses the same path lookup used by the `-include_lib` |