Skip to content

Change first doctest for case/2 #14432

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.

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 1 commit into from
Apr 12, 2025
Merged
Changes from all commits
Commits
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
19 changes: 9 additions & 10 deletions lib/elixir/lib/kernel/special_forms.ex
Original file line number Diff line number Diff line change
Expand Up @@ -1914,20 +1914,19 @@ defmodule Kernel.SpecialForms do

## Examples

iex> file = "no_file.txt"
iex> case File.read(file) do
...> {:ok, contents} when is_binary(contents) ->
...> String.split(contents, "\n")
...> {:error, _reason} ->
...> "Can't read the #{file} file"
iex> string_date = "2015-01-23"
iex> case Date.from_iso8601(string_date) do
...> {:ok, date} -> date
...> {:error, _reason} -> Date.utc_today()
...> end
"Can't read the no_file.txt file"
~D[2015-01-23]

In the example above, we match the result of `File.read/1`
In the example above, we match the result of `Date.from_iso8601/1`
against each clause "head" and execute the clause "body"
corresponding to the first clause that matches. In our case
there is no file, so `File.read/1` returns `{:error, :enoent}`
and the second clause is matched.
`string_date` contains a string with a valid ISO 8601 representation
of date. The function returns `{:ok, ~D[2015-01-23]}`, so the
`{:ok, date}` clause is matched.

If no clause matches, an error is raised. For this reason,
it may be necessary to add a final catch-all clause (like `_`)
Expand Down