Commit Graph

36 Commits

Author SHA1 Message Date
Martin Hořeňovský 5cd8938905
Update explanation of REQUIRE_FALSE in docs/assertions.md 2022-10-17 15:13:00 +02:00
Martin Hořeňovský 6a422bae0b
Trim superfluous whitespace in docs 2022-10-17 15:02:45 +02:00
Martin Hořeňovský a07ac3f935
Rewrite explanation of problems with && and || in assertions 2022-10-17 12:36:02 +02:00
Martin Hořeňovský 0c962d11b3
Centralize and update docs for floating point comparisons
The new docs mention that Approx is deprecated and should not be
used, and explain the reasons behind it.

Closes #1444
2022-10-15 11:02:58 +02:00
Martin Hořeňovský ab80277a86
Improve the REQUIRE_THROWS_MATCHES documentation a bit 2019-07-29 20:39:02 +02:00
Clare Macrae 448825db03 Readability improvements for assertions.md 2019-03-09 18:02:29 +01:00
Martin Hořeňovský dfb025cf08 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
2018-09-21 20:04:56 +02:00
Martin Hořeňovský ce80358306 Document Approx's UDL support 2018-07-15 17:38:57 +02:00
Martin Hořeňovský 5eeb6aa361 Update Approx documentation
Fixes #1328
2018-07-05 17:28:00 +02:00
Cristian Morales Vega 7abd7db2c8 Fix minor typo in the documentation 2018-06-01 22:24:49 +02:00
Barry 200d3ad824 Support for parenthesizing types with commas. 2018-04-20 15:11:09 +02:00
Josh Soref b11175548a Fixup various spelling errors (#1208) 2018-03-07 10:08:35 +01:00
Dan Nissenbaum 88d2bac624 Trivial typo fix. (#1119) 2017-12-09 21:29:39 +01:00
Martin Hořeňovský a49e6fdc27 Update Approx documentation 2017-11-01 13:45:21 +01:00
Martin Hořeňovský 276393e4e5 Change ToC script to use <br> instead of trailing spaces
Also updated docs that contain ToC. Fixes #1048
2017-10-13 11:17:38 +02:00
Martin Moene 07211cea9c Add table of contents 2017-08-29 17:25:24 +02:00
Martin Moene 6c09b45a20 Let toplevel links to .md files link to .md#top 2017-08-24 19:40:36 +02:00
Martin Moene e8225052f1 Add html anchor 'top' 2017-08-24 19:40:36 +02:00
Martin Hořeňovský a14bd08b27 Update documentation to reflect the last change 2017-07-19 21:34:06 +02:00
Martin Hořeňovský c465fbd0ea Slight documentation improvements 2017-06-05 18:42:04 +02:00
Martin Hořeňovský 950cae9040 Added new assertion macros: `*_THROWS_WITH`
It combines `*_THROWS_AS` and `*_THROWS_WITH` macros, so that the
exception type matches expectetations and its contents match a specific
matcher.
2017-06-05 18:40:50 +02:00
Phil Nash b591cb9a03 Added note about thread safety in assertions
- closes #875
2017-04-11 14:25:19 +01:00
Martin Hořeňovský d762a7ca6c Expanded documentation about THROWS_AS assertions 2017-03-23 21:16:52 +01:00
Martin Hořeňovský e4f4335b07 Improved Approx documentation 2017-02-27 14:22:17 +01:00
Phil Nash d4ae1b18c0 Matcher documentation 2017-02-14 09:16:54 +00:00
Phil Nash 1e87cae8af Documented the _THROWS_WITH macros, as well as slightly expanding the matchers docs. 2017-02-08 16:18:53 +00:00
Martin Hořeňovský f126d7943a Add explanation of THROW assertion limits + using lambda 2017-02-06 16:08:13 +01:00
Martin Hořeňovský c97ada1910 Improved assertion documentation
Mentioned that decomposing `&&` and `||` is not supported, gave examples
+ possible workarounds.

Closes #621, #787, #341 and maybe others I haven't found.
2017-01-30 19:42:27 +01:00
Phil Nash acf638f2bc Added docs for floating point comparisons 2014-12-17 18:45:50 +00:00
Phil Nash 32186db1b0 Added first cut of docs for configuring Catch
- initially just covers new colour config
- also updated all [Home] links in footers to go to local readme
2014-10-21 18:25:57 +01:00
Alex Moreno c6022381f5 Fixed typo 2014-06-11 15:17:17 +08:00
Zhihao Yuan a9cd3a0ef8 fix macro syntax in doc 2014-05-28 18:27:34 -04:00
Phil Nash 34266b6e0f more doc formatting fixes 2013-10-02 08:17:46 +01:00
Phil Nash b9c6d30631 minor doc tweaks 2013-10-02 07:58:15 +01:00
Phil Nash fd1cd7820d Completed assertions docs 2013-06-10 08:18:26 +01:00
Phil Nash 46953c8319 Filled out reference index and added placeholders for assertions and logging docs 2013-06-10 08:08:20 +01:00