diff options
author | onqtam <vik.kirilov@gmail.com> | 2018-11-29 16:22:36 +0200 |
---|---|---|
committer | onqtam <vik.kirilov@gmail.com> | 2018-11-29 16:22:36 +0200 |
commit | 835a0fa2990c30996bd7b21f0c5a9c7085e4f944 (patch) | |
tree | 30bda05c4924e51b2683e44d7a6b1ee432b14cab | |
parent | 95bd26d4b9c7753ec7cdaf99b0c8e0b8f4c2e442 (diff) |
small fixes in the docs
-rw-r--r-- | .travis.yml | 1 | ||||
-rw-r--r-- | README.md | 3 | ||||
-rw-r--r-- | doc/markdown/faq.md | 4 |
3 files changed, 5 insertions, 3 deletions
diff --git a/.travis.yml b/.travis.yml index 7a924c7..25ed040 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,7 +1,6 @@ # this file is HEAVILY influenced by https://github.com/boostorg/hana/blob/master/.travis.yml dist: trusty -sudo: false language: c++ notifications: @@ -59,6 +59,7 @@ The **key** differences between it and other testing frameworks are that it is l - asserts can be used [**outside of a testing context**](doc/markdown/assertions.md#using-asserts-out-of-a-testing-context) - as a general purpose assert library - [**example**](examples/all_features/asserts_used_outside_of_tests.cpp) - Doesn't pollute the global namespace (everything is in namespace ```doctest```) and doesn't drag **any** headers with it - Very [**portable**](doc/markdown/features.md#extremely-portable) C++11 (use tag [**1.2.9**](https://github.com/onqtam/doctest/tree/1.2.9) for C++98) with over 180 different CI builds (static analysis, sanitizers...) +- binaries (exe/dll) can use the test runner of another binary - so tests end up in a single registry - [**example**](../../examples/executable_dll_and_plugin/) ![cost-of-including-the-framework-header](scripts/data/benchmarks/header.png) @@ -77,7 +78,7 @@ The framework can be used like any other if you don't want/need to mix productio [This table](https://github.com/martinmoene/catch-lest-other-comparison) compares **doctest** / [**Catch**](https://github.com/philsquared/Catch) / [**lest**](https://github.com/martinmoene/lest) which are all very similar. -[![Standard](https://img.shields.io/badge/c%2B%2B-98/11/14/17-blue.svg)](https://en.wikipedia.org/wiki/C%2B%2B#Standardization) +[![Standard](https://img.shields.io/badge/c%2B%2B-11/14/17-blue.svg)](https://en.wikipedia.org/wiki/C%2B%2B#Standardization) [![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/MIT) [![Version](https://badge.fury.io/gh/onqtam%2Fdoctest.svg)](https://github.com/onqtam/doctest/releases) [![download](https://img.shields.io/badge/download%20%20-latest-blue.svg)](https://raw.githubusercontent.com/onqtam/doctest/master/doctest/doctest.h) diff --git a/doc/markdown/faq.md b/doc/markdown/faq.md index 0f533e3..cc34376 100644 --- a/doc/markdown/faq.md +++ b/doc/markdown/faq.md @@ -17,6 +17,7 @@ Pros of **doctest**: - **doctest** is [**thread-safe**](faq.md#is-doctest-thread-aware) +- asserts can be used [**outside of a testing context**](assertions.md#using-asserts-out-of-a-testing-context) - including the **doctest** header is [**over 20 times lighter**](benchmarks.md#cost-of-including-the-header) on compile times than that of [**Catch**](https://github.com/philsquared/Catch) - the asserts in **doctest** can be [**many times lighter**](benchmarks.md#cost-of-an-assertion-macro) on compile times than those of [**Catch**](https://github.com/philsquared/Catch) - **doctest** executes tests [**many times faster**](benchmarks.md#runtime-benchmarks) than [**Catch**](https://github.com/philsquared/Catch) @@ -25,8 +26,9 @@ Pros of **doctest**: - 0 warnings even on the [**most aggressive**](../../scripts/cmake/common.cmake#L84) warning levels for MSVC/GCC/Clang - per commit tested with 180+ builds on [**much more compilers**](features.md#extremely-portable) - and through valgrind/sanitizers/analyzers - test cases can be written in headers - the framework will still register the tests only once - no duplicates +- binaries (exe/dll) can use the test runner of another binary - so tests end up in a single registry - [**example**](../../examples/executable_dll_and_plugin/) -Aside from everything mentioned so far doctest has some [**features**](features.md#other-features) (like [**templated test cases**](parameterized-tests.md#templated-test-cases---parameterized-by-type)) which [**Catch**](https://github.com/philsquared/Catch) doesn't. +Aside from everything mentioned so far doctest has some [**features**](features.md#other-features) (like [**test suites**](testcases.md#test-suites) and [**decorators**](testcases.md#decorators)) which [**Catch**](https://github.com/philsquared/Catch) doesn't. Missing stuff: |