3rd-party/catch2
1
0
Fork 0
mirror of https://github.com/catchorg/Catch2.git synced 2024-12-23 11:43:29 +01:00
Code Issues Packages Projects Releases Wiki Activity

Change wording of Approx documentation to be less misleading

Browse Source 
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
This commit is contained in:
Martin Hořeňovský 2018-09-21 20:04:56 +02:00
parent c638c57209
commit dfb025cf08
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/assertions.md
View File

@ -71,7 +71,7 @@ REQUIRE( performComputation() == 2.1_a );
`Approx` is constructed with defaults that should cover most simple cases. `Approx` is constructed with defaults that should cover most simple cases.
For the more complex cases, `Approx` provides 3 customization points: 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. can differ from `Approx`'s value before it is rejected.
_By default set to `std::numeric_limits<float>::epsilon()*100`._ _By default set to `std::numeric_limits<float>::epsilon()*100`._
* __margin__ - margin serves to set the the absolute value by which * __margin__ - margin serves to set the the absolute value by which