Skip to content

Commit ce6f4e6

Browse files
author
José Valim
committed
Clean up ExUnit.Assertions docs
1 parent 3210966 commit ce6f4e6

File tree

1 file changed

+5
-17
lines changed

1 file changed

+5
-17
lines changed

lib/ex_unit/lib/ex_unit/assertions.ex

Lines changed: 5 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -207,26 +207,16 @@ defmodule ExUnit.Assertions do
207207
true
208208
end
209209

210-
@doc """
211-
Asserts `value` is true.
212-
If it fails, it raises an expectation error
213-
using the given `left` and `right` values.
214-
215-
You probably don't need to use this—the regular `assert` function
216-
handles this for you.
217-
218-
## Examples
219-
220-
assert this > that, this, that, "more than"
221-
222-
"""
210+
@doc false
223211
def assert(value, left, right, message) when is_binary(message) do
224212
assert(value, left: left, right: right, message: message)
225213
end
226214

227215
@doc """
228-
Asserts a message was or is going to be received. Unlike
229-
`assert_received`, it has a default timeout of 100 milliseconds.
216+
Asserts a message was or is going to be received.
217+
218+
Unlike `assert_received`, it has a default timeout
219+
of 100 milliseconds.
230220
231221
The `expected` argument is a pattern.
232222
@@ -460,8 +450,6 @@ defmodule ExUnit.Assertions do
460450
end
461451

462452
@doc """
463-
refute_receive message, timeout \\ 100, message \\ nil
464-
465453
Asserts `message` was not received (and won't be received) within
466454
the `timeout` period.
467455

0 commit comments

Comments
 (0)