Skip to content

Fix typos in with docstring #13680

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
Jun 21, 2024
Merged

Fix typos in with docstring #13680

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a76da21
docs: typo: highlight 'with' as code
cmcaine Jun 21, 2024
3d90806
docs: an 'else' is like a 'case', not a clause
cmcaine Jun 21, 2024
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
4 changes: 2 additions & 2 deletions lib/elixir/lib/kernel/special_forms.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1539,7 +1539,7 @@ defmodule Kernel.SpecialForms do
@doc """
Combine matching clauses.

One of the ways to understand with is to show which code
One of the ways to understand `with` is to show which code
patterns it improves. Imagine you have a map where the fields
`width` and `height` are optional and you want to compute its
area, as `{:ok, area}` or return `:error`. We could implement
Expand Down Expand Up @@ -1661,7 +1661,7 @@ defmodule Kernel.SpecialForms do
...> end
{:error, :wrong_data}

The `else` block works like a `case` clause: it can have multiple clauses,
The `else` block works like a `case`: it can have multiple clauses,
and the first match will be used. Variables bound inside `with` (such as
`width` in this example) are not available in the `else` block.

Expand Down