3rd-party/catch2
1
0
Fork 0
mirror of https://github.com/catchorg/Catch2.git synced 2025-03-09 21:24:46 +01:00
Code Issues Packages Projects Releases Wiki Activity
catch2/docs
History
Alex Merry 966d361551 Improve formatting of test specification docs 
The existing formatting created one-element lists separated by paragraphs, when it would make more sense to have the paragraphs that are providing more information about one of those list entries be part of the list entry itself.

I think this makes the documentation easier to read in both markdown and html form, and should also improve the structure for assistive technologies.
2023-10-24 16:01:56 +02:00
..
assertions.md
Update explanation of REQUIRE_FALSE in docs/assertions.md
2022-10-17 15:13:00 +02:00
benchmarks.md
Update sample output in docs/benchmarks.md
2023-09-08 10:04:17 +02:00
ci-and-misc.md
v3.2.0
2022-11-16 20:05:48 +01:00
cmake-integration.md
Catch.cmake: Add new DISCOVERY_MODE option to catch_discover_tests
2023-04-19 23:51:42 +02:00
command-line.md
Improve formatting of test specification docs
2023-10-24 16:01:56 +02:00
commercial-users.md
Trim superfluous whitespace in docs
2022-10-17 15:02:45 +02:00
comparing-floating-point-numbers.md
Update comparing-floating-point-numbers.md
2022-10-29 12:42:45 +02:00
configuration.md
Introduce CATCH_CONFIG_PREFIX_MESSAGES to only prefix a few logging related macros. (#2544)
2023-07-19 17:04:43 +02:00
contributing.md
Update build instructions in contributing.md
2023-02-22 20:11:45 +01:00
deprecations.md
Add SUCCEED and FAIL docs next to SKIP docs
2023-01-12 20:38:58 +01:00
event-listeners.md
Trim superfluous whitespace in docs
2022-10-17 15:02:45 +02:00
faq.md
Mention missing catch_user_config.hpp in FAQ
2023-08-11 15:36:23 +02:00
generators.md
Test & document SKIP in generator constructor
2023-05-31 15:12:43 +02:00
limitations.md
Update docs about thread safe assertions
2023-02-01 15:24:47 +01:00
list-of-examples.md
Examples: remove references to catch_default_main
2022-02-20 13:10:42 +01:00
logging.md
Fix introduced in version placeholders
2021-03-13 10:26:12 +01:00
matchers.md
v3.3.2
2023-02-27 15:12:49 +01:00
migrate-v2-to-v3.md
Explain TU as translation unit where appropriate
2022-09-03 22:22:10 +02:00
opensource-users.md
Add SFML to the list of open source users
2023-05-13 14:34:34 -06:00
other-macros.md
v3.0.1
2022-05-17 22:13:36 +02:00
own-main.md
Rewrite own-main.md for v3
2021-11-19 15:52:32 +01:00
Readme.md
Add SUCCEED and FAIL docs next to SKIP docs
2023-01-12 20:38:58 +01:00
release-notes.md
Add missing line for v3.4.0 to ToC in release-notes.md
2023-08-11 15:36:03 +02:00
release-process.md
Update release-process.md for v3
2022-01-03 23:30:39 +01:00
reporter-events.md
Fix assertionStarting events being sent after the expr is evaluated
2023-05-06 11:48:41 +02:00
reporters.md
Fix typo in cross-docs links
2023-06-11 19:37:15 +02:00
skipping-passing-failing.md
Test & document SKIP in generator constructor
2023-05-31 15:12:43 +02:00
test-cases-and-sections.md
Rewrite -# docs
2023-02-17 15:55:21 +01:00
test-fixtures.md
Trim superfluous whitespace in docs
2022-10-17 15:02:45 +02:00
tostring.md
Fix introduced in version placeholders
2021-03-13 10:26:12 +01:00
tutorial.md
Trim superfluous whitespace in docs
2022-10-17 15:02:45 +02:00
usage-tips.md
Fix typos in docs (#2514)
2022-09-09 16:00:39 +02:00
why-catch.md
why-catch.md: Add JetBrains survey link
2023-09-27 20:14:35 +02:00

Readme.md

Reference

To get the most out of Catch2, start with the tutorial. Once you're up and running consider the following reference material.

Writing tests:

Fine tuning:

Running:

Odds and ends:

Other: