Skip to content

Commit 34ad157

Browse files
authored
Merge pull request #1 from chriselrod/patch-1
Make test/reference fun more descriptive.
2 parents 2cdbb89 + 22354c9 commit 34ad157

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ Construct an indexable iterator over all floating point values between min and m
99

1010

1111
`test_acc` - Function
12-
* `test_acc(Dict(old_fun=>new_fun), xs; tol=1.5)`
12+
* `test_acc(Dict(test_fun=>reference_fun), xs; tol=1.5)`
1313

14-
This tests whether `old_fun` and `new_fun` produce the same result on an iterator of `x` values. `tol` is the tolerance specified in ULPs (Units in Last Place).
14+
This tests whether `test_fun` and `reference_fun` produce the same result on an iterator of `x` values. `tol` is the tolerance specified in ULPs (Units in Last Place). The `reference_fun` should be the accurate "reference" function you're comparing your new "test" function with.
1515
* `test_acc(f::Function, xx; tol = 1.5)`
1616

1717
This is the same, except it tests the `BigFloat` method of a function against the method for `eltype(xx)`.

0 commit comments

Comments
 (0)