From caa9b41af98024968986ce877f154932ab0a29a0 Mon Sep 17 00:00:00 2001 From: Danny Hermes Date: Mon, 19 Mar 2018 10:37:00 -0700 Subject: [PATCH] Lint fix (added documentation for a newly added parameter). --- tests/functional/utils.py | 3 +++ 1 file changed, 3 insertions(+) diff --git a/tests/functional/utils.py b/tests/functional/utils.py index 32d856eb..2d0ca6f0 100644 --- a/tests/functional/utils.py +++ b/tests/functional/utils.py @@ -215,6 +215,9 @@ def ulps_away(value1, value2, num_bits=1, eps=0.5 ** 40): value2 (float): The second value that being compared. num_bits (Optional[int]): The number of bits allowed to differ. Defaults to ``1``. + eps (Optional[float]): The "zero threshold" to use when one of + ``value1`` / ``value2`` is zero, but the other is not. Will + only be used on 32-bit Linux. Returns: bool: Predicate indicating if the values agree to ``n`` bits.