diff options
| author | Martin Hořeňovský | 2022-07-15 19:49:21 +0200 |
|---|---|---|
| committer | Martin Hořeňovský | 2022-07-15 19:49:24 +0200 |
| commit | a6d59b62b2c2054e892fc62be66b3f5045ca8c3c (patch) | |
| tree | 8490e063d47751272baae180da2b37d361720cba | |
| parent | cc0e91472aa7f5dc28388be57c2ee8d3340c365f (diff) | |
| download | catch3-a6d59b62b2c2054e892fc62be66b3f5045ca8c3c.tar.gz | |
Remove obsolete link to benchmarking tests
The benchmarking feature is now documented, so there is no need
to direct our users towards our test file to understand how it
works.
Closes #2471
| -rw-r--r-- | docs/test-cases-and-sections.md | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/docs/test-cases-and-sections.md b/docs/test-cases-and-sections.md index d42b9a23..613bbd14 100644 --- a/docs/test-cases-and-sections.md +++ b/docs/test-cases-and-sections.md @@ -72,7 +72,8 @@ All tag names beginning with non-alphanumeric characters are reserved by Catch. * `[@<alias>]` - tag aliases all begin with `@` (see below). -* `[!benchmark]` - this test case is actually a benchmark. This is an experimental feature, and currently has no documentation. If you want to try it out, look at `projects/SelfTest/Benchmark.tests.cpp` for details. +* `[!benchmark]` - this test case is actually a benchmark. Currently this only serves to hide the test case by default, to avoid the execution time costs. + ## Tag aliases |