Skip to content

Add documentation for string keys in Keyword's colon syntax #7210

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

Merged
merged 2 commits into from
Jan 15, 2018
Merged

Add documentation for string keys in Keyword's colon syntax #7210

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8e0901d
Add notes for using string keys in colon syntax
unnawut Jan 14, 2018
97b95a6
Update keyword.ex
josevalim Jan 15, 2018
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
15 changes: 11 additions & 4 deletions lib/elixir/lib/keyword.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,17 @@ defmodule Keyword do
iex> [{:active, :once}]
[active: :once]

The two syntaxes are completely equivalent. Note that when keyword
lists are passed as the last argument to a function, if the short-hand
syntax is used then the square brackets around the keyword list can
be omitted as well. For example, the following:
The two syntaxes are completely equivalent. When using the colon syntax,
the key is always an atom, even when wrapped in quotes:

iex> ["exit_on_close": true]
[exit_on_close: true]

This mirrors the quoted atom syntax such as `:"exit_on_close"`.

Note that when keyword lists are passed as the last argument to a function,
if the short-hand syntax is used then the square brackets around the keyword list
can be omitted as well. For example, the following:

String.split("1-0", "-", trim: true, parts: 2)

Expand Down