Skip to content

Commit 7c182d8

Browse files
eksperimentaljosevalim
authored andcommitted
Use proper names when describing boolean operator args. (#7859)
[ci skip]
1 parent 62e3105 commit 7c182d8

File tree

1 file changed

+6
-8
lines changed

1 file changed

+6
-8
lines changed

lib/elixir/lib/kernel.ex

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1485,11 +1485,10 @@ defmodule Kernel do
14851485
@doc """
14861486
Boolean or.
14871487
1488-
If the first argument is `true`, `true` is returned; otherwise, the second
1489-
argument is returned.
1488+
If `left` is `true`, returns `true`; otherwise returns `right`.
14901489
1491-
Requires only the first argument to be a boolean since it short-circuits.
1492-
If the first argument is not a boolean, an `ArgumentError` exception is
1490+
Requires only the `left` operand to be a boolean since it short-circuits.
1491+
If the `left` operand is not a boolean, an `ArgumentError` exception is
14931492
raised.
14941493
14951494
Allowed in guard tests.
@@ -1513,11 +1512,10 @@ defmodule Kernel do
15131512
@doc """
15141513
Boolean and.
15151514
1516-
If the first argument is `false`, `false` is returned; otherwise, the second
1517-
argument is returned.
1515+
If `left` is `false`, returns `false`; otherwise returns `right`.
15181516
1519-
Requires only the first argument to be a boolean since it short-circuits. If
1520-
the first argument is not a boolean, an `ArgumentError` exception is raised.
1517+
Requires only the `left` operand to be a boolean since it short-circuits. If
1518+
the `left` operand is not a boolean, an `ArgumentError` exception is raised.
15211519
15221520
Allowed in guard tests.
15231521

0 commit comments

Comments
 (0)