mirror of
https://github.com/catchorg/Catch2.git
synced 2024-11-16 10:42:25 +01:00
966d361551
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. |
||
|---|---|---|
| .. | ||
| assertions.md | ||
| benchmarks.md | ||
| ci-and-misc.md | ||
| cmake-integration.md | ||
| command-line.md | ||
| commercial-users.md | ||
| comparing-floating-point-numbers.md | ||
| configuration.md | ||
| contributing.md | ||
| deprecations.md | ||
| event-listeners.md | ||
| faq.md | ||
| generators.md | ||
| limitations.md | ||
| list-of-examples.md | ||
| logging.md | ||
| matchers.md | ||
| migrate-v2-to-v3.md | ||
| opensource-users.md | ||
| other-macros.md | ||
| own-main.md | ||
| Readme.md | ||
| release-notes.md | ||
| release-process.md | ||
| reporter-events.md | ||
| reporters.md | ||
| skipping-passing-failing.md | ||
| test-cases-and-sections.md | ||
| test-fixtures.md | ||
| tostring.md | ||
| tutorial.md | ||
| usage-tips.md | ||
| why-catch.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:
- Assertion macros
- Matchers (asserting complex properties)
- Comparing floating point numbers
- Logging macros
- Test cases and sections
- Test fixtures
- Explicitly skipping, passing, and failing tests at runtime
- Reporters (output customization)
- Event Listeners
- Data Generators (value parameterized tests)
- Other macros
- Micro benchmarking
Fine tuning:
Running:
Odds and ends:
- Frequently Asked Questions (FAQ)
- Best practices and other tips
- CMake integration
- Tooling integration (CI, test runners, other)
- Known limitations
Other: