mirror of https://github.com/catchorg/Catch2.git synced 2025-10-17 22:36:13 -04:00

Files

Martin Hořeňovský 31ee3beb0a Small documentation fixes

This includes 2 small typos I found when working on generator skipping,
and 1 typo found by @sfraczek in #3039.

Closes #3039

2025-10-16 20:45:28 +02:00

assertions.md

Use correct matcher name in the matcher example in assertion docs

2024-08-13 19:21:07 +02:00

benchmarks.md

Update sample output in docs/benchmarks.md

2023-09-08 10:04:17 +02:00

ci-and-misc.md

v3.11.0

2025-09-30 10:54:31 +02:00

cmake-integration.md

Use latest release in docs

2025-06-15 13:05:41 -06:00

command-line.md

v3.11.0

2025-09-30 10:54:31 +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

v3.9.0

2025-07-24 22:01:46 +02:00

contributing.md

Simplify instructions by not changing directories for the ctest command

2024-09-13 14:45:04 +02:00

deprecations.md

Backfill release version placeholders that used wrong format

2025-07-24 00:02:08 +02:00

event-listeners.md

Small documentation fixes

2025-10-16 20:45:28 +02:00

faq.md

v3.5.0

2023-12-11 00:55:40 +01:00

generators.md

Small documentation fixes

2025-10-16 20:45:28 +02:00

limitations.md

Remove 'thread safe assertions' from limitations.md

2025-07-24 21:57:49 +02:00

list-of-examples.md

TEST_CASE_PERSISTENT_FIXTURE: A new fixture macro for allowing persistent fixtures throughout a TEST_CASE (#2885 )

2024-08-05 17:01:41 +02:00

logging.md

Regularize scoped message lifetime to only consider the object's scope

2025-07-21 21:50:47 +02:00

matchers.md

Update docs for REQUIRE_THROWS_MATCHES

2024-07-27 14:02:28 +02: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

TEST_CASE_PERSISTENT_FIXTURE: A new fixture macro for allowing persistent fixtures throughout a TEST_CASE (#2885 )

2024-08-05 17:01:41 +02:00

own-main.md

Add return code constants to API

2025-04-29 09:26:28 -06:00

Readme.md

Link to the thread safety documentation from docs/Readme.md

2025-07-24 21:59:56 +02:00

release-notes.md

v3.11.0

2025-09-30 10:54:31 +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

v3.9.0

2025-07-24 22:01:46 +02:00

skipping-passing-failing.md

Small documentation fixes

2025-10-16 20:45:28 +02:00

test-cases-and-sections.md

Fix typo in test-cases-and-sections.md

2024-08-13 12:28:03 +02:00

test-fixtures.md

Add configuration option to make assertions thread-safe

2025-07-24 10:10:00 +02:00

thread-safety.md

v3.10.0

2025-08-25 21:30:21 +02:00

tostring.md

Fix wrong reference to REGISTER_ENUM

2024-11-12 23:29:54 +01:00

tutorial.md

Improve tutorial.md with link to two-file setup instructions.

2024-02-19 15:01:14 +01:00

usage-tips.md

Fix typos in docs (#2514 )

2022-09-09 16:00:39 +02:00

why-catch.md

Fix minor typos in documentation (#2769 )

2023-12-10 22:01:13 +01: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:

Command line

Odds and ends:

Other: