Progmasoft Git

catch3

Progmasoft Catch3: an independently maintained C++17 test framework with a parallel runner, property checks, snapshots and structured results.

Clonegit clone https://git.progmasoft.com/catch3

Change wording of Approx documentation to be less misleading

The "percentage" suggests that the expected epsilon can be in
[0, 100], but the expected values are in [0, 1]. The new wording
uses "coefficient", to make it clearer that we are talking about
values in [0, 1].

Closes #1388
Commit
dfb025cf089adce25810fe4074cddc4ba006a476
Author
Martin Hořeňovský ·
Parents
c638c5720970

Files · Download .tar.gz

Changes

 docs/assertions.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/docs/assertions.md b/docs/assertions.md
index 865fdd6c..900fd52c 100644
--- a/docs/assertions.md
+++ b/docs/assertions.md
@@ -71,7 +71,7 @@ REQUIRE( performComputation() == 2.1_a );
 `Approx` is constructed with defaults that should cover most simple cases.
 For the more complex cases, `Approx` provides 3 customization points:
 
-* __epsilon__ - epsilon serves to set the percentage by which a result
+* __epsilon__ - epsilon serves to set the coefficient by which a result
 can differ from `Approx`'s value before it is rejected.
 _By default set to `std::numeric_limits<float>::epsilon()*100`._
 * __margin__ - margin serves to set the the absolute value by which