Skip to content

Add additional documentation for assert_in_delta and refute_in_delta #7191

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
josevalim merged 3 commits into from
Jan 9, 2018
Merged

Add additional documentation for assert_in_delta and refute_in_delta #7191

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7aeb6b4
Add additional documentation for `assert_in_delta` and `refute_in_delta`
devonestes Jan 9, 2018
bcb008c
Keep first line of docs short
josevalim Jan 9, 2018
6074271
Remove trailing whitespace
josevalim Jan 9, 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
8 changes: 7 additions & 1 deletion lib/ex_unit/lib/ex_unit/assertions.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -670,11 +670,14 @@ defmodule ExUnit.Assertions do
@doc """
Asserts that `value1` and `value2` differ by no more than `delta`.

This difference is inclusive, so the test will pass if the difference
and the `delta` are equal.

## Examples

assert_in_delta 1.1, 1.5, 0.2
assert_in_delta 10, 15, 4
assert_in_delta 10, 15, 2
assert_in_delta 10, 15, 5

"""
def assert_in_delta(value1, value2, delta, message \\ nil)
Expand Down Expand Up @@ -840,6 +843,9 @@ defmodule ExUnit.Assertions do
@doc """
Asserts `value1` and `value2` are not within `delta`.

This difference is exclusive, so the test will fail if the difference
and the delta are equal.

If you supply `message`, information about the values will
automatically be appended to it.

Expand Down