diff options
author | warmsocks <warmsocks@gmail.com> | 2019-09-12 01:24:04 -0700 |
---|---|---|
committer | onqtam <vik.kirilov@gmail.com> | 2019-09-22 21:14:40 +0300 |
commit | 33cc7f9b622197eaea5d8aeb1fb206d0fe9f039f (patch) | |
tree | a5f7d558a9333694d26b732d7180da0846870c90 | |
parent | 4552c018df026c5ac36642efcf4b3074a023db4f (diff) |
Fix typos and misspellings found by codespell. (#292)
24 files changed, 29 insertions, 29 deletions
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 1670c51..843c61c 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -10,7 +10,7 @@ file, it is generated from the 2 headers in the doctest/parts/ folder. <!-- Describe the what and the why of your pull request. Remember that these two are usually a bit different. As an example, if you have made various changes -to decrease the number of new strings allocated, thats what. The why probably +to decrease the number of new strings allocated, that's what. The why probably was that you have a large set of tests and found that this speeds them up. --> diff --git a/CHANGELOG.md b/CHANGELOG.md index bc71518..4394adb 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -108,7 +108,7 @@ - Fix unmatched bracket in DOCTEST\_TEST\_CASE\_CLASS [\#204](https://github.com/onqtam/doctest/pull/204) ([patstew](https://github.com/patstew)) - Template apply [\#203](https://github.com/onqtam/doctest/pull/203) ([zhihaoy](https://github.com/zhihaoy)) -- No undefined behavior per C++ standard in detecting endianess. [\#195](https://github.com/onqtam/doctest/pull/195) ([dimztimz](https://github.com/dimztimz)) +- No undefined behavior per C++ standard in detecting endianness. [\#195](https://github.com/onqtam/doctest/pull/195) ([dimztimz](https://github.com/dimztimz)) - Fix propagating include directories of target doctest\_with\_main [\#193](https://github.com/onqtam/doctest/pull/193) ([dimztimz](https://github.com/dimztimz)) - Move single header to a separate folder [\#187](https://github.com/onqtam/doctest/pull/187) ([dimztimz](https://github.com/dimztimz)) - Fix Clang format to handle C++11 [\#186](https://github.com/onqtam/doctest/pull/186) ([dimztimz](https://github.com/dimztimz)) @@ -250,7 +250,7 @@ - Nullptr issue. [\#110](https://github.com/onqtam/doctest/issues/110) - MemorySanitizer: use-of-uninitialized-value [\#109](https://github.com/onqtam/doctest/issues/109) - Potential memory leak through scan-build [\#108](https://github.com/onqtam/doctest/issues/108) -- Warnings raised to error with lastest MSVC version [\#107](https://github.com/onqtam/doctest/issues/107) +- Warnings raised to error with latest MSVC version [\#107](https://github.com/onqtam/doctest/issues/107) - New solution for tests in static libraries ! \(MSVC\) [\#106](https://github.com/onqtam/doctest/issues/106) - Command line flags do not work after code formatter/beautifier [\#104](https://github.com/onqtam/doctest/issues/104) - Cppcheck 1.81 warnings [\#102](https://github.com/onqtam/doctest/issues/102) @@ -422,7 +422,7 @@ **Merged pull requests:** -- dont show green when tests fail [\#26](https://github.com/onqtam/doctest/pull/26) ([ferkulat](https://github.com/ferkulat)) +- don't show green when tests fail [\#26](https://github.com/onqtam/doctest/pull/26) ([ferkulat](https://github.com/ferkulat)) - Include "program code" in example [\#15](https://github.com/onqtam/doctest/pull/15) ([martinmoene](https://github.com/martinmoene)) ## [1.0.0](https://github.com/onqtam/doctest/tree/1.0.0) (2016-05-22) diff --git a/doc/html_generated/commandline.html b/doc/html_generated/commandline.html index b0b444a..88f27c4 100644 --- a/doc/html_generated/commandline.html +++ b/doc/html_generated/commandline.html @@ -27,7 +27,7 @@ All the options can also be set with code (defaults/overrides) if the user [**su | ```-lts``` ```--list-test-suites``` | Lists all test suites by name which have at least one test case matching the current filters (see below) | | ```-lr``` ```--list-reporters``` | Lists all registered [**reporters**](reporters.html) | | **Int/String Options** | <hr> | -| ```-tc``` ```--test-case=<filters>``` | Filters test cases based on their name. By default all test cases match but if a value is given to this filter like ```--test-case=*math*,*sound*``` then only test cases who match atleast one of the patterns in the comma-separated list with wildcards will get executed/counted/listed | +| ```-tc``` ```--test-case=<filters>``` | Filters test cases based on their name. By default all test cases match but if a value is given to this filter like ```--test-case=*math*,*sound*``` then only test cases who match at least one of the patterns in the comma-separated list with wildcards will get executed/counted/listed | | ```-tce``` ```--test-case-exclude=<filters>``` | Same as the ```-test-case=<filters>``` option but if any of the patterns in the comma-separated list of values matches - then the test case is skipped | | ```-sf``` ```--source-file=<filters>``` | Same as ```--test-case=<filters>``` but filters based on the file in which test cases are written | | ```-sfe``` ```--source-file-exclude=<filters>``` | Same as ```--test-case-exclude=<filters>``` but filters based on the file in which test cases are written | diff --git a/doc/html_generated/faq.html b/doc/html_generated/faq.html index 22d7149..15d968e 100644 --- a/doc/html_generated/faq.html +++ b/doc/html_generated/faq.html @@ -84,7 +84,7 @@ The areas where doctest is behind are planned for improvement in the future. The ### How to get the best compile-time performance with the framework? -The [**```DOCTEST_CONFIG_SUPER_FAST_ASSERTS```**](configuration.html#doctest_config_super_fast_asserts) config option yelds the [**fastest possible**](benchmarks.html#cost-of-an-assertion-macro) compile times (up to 31-91%). Also the expression-decomposing template machinery can be skipped by using the [**binary**](assertions.html#binary-and-unary-asserts) asserts. +The [**```DOCTEST_CONFIG_SUPER_FAST_ASSERTS```**](configuration.html#doctest_config_super_fast_asserts) config option yields the [**fastest possible**](benchmarks.html#cost-of-an-assertion-macro) compile times (up to 31-91%). Also the expression-decomposing template machinery can be skipped by using the [**binary**](assertions.html#binary-and-unary-asserts) asserts. There are only 2 tiny drawbacks of using this config option: diff --git a/doc/html_generated/features.html b/doc/html_generated/features.html index 02e6035..86c9129 100644 --- a/doc/html_generated/features.html +++ b/doc/html_generated/features.html @@ -16,7 +16,7 @@ - doesn't drag any headers when included (except for in the translation unit where the library gets implemented) - everything is in the ```doctest``` namespace (and the implementation details are in a nested ```detail``` namespace) - all macros have prefixes - some by default have unprefixed versions as well but that is optional - see [**configuration**](configuration.html) -- 0 warnings even with the most aggresive flags (on all tested compilers!!!) +- 0 warnings even with the most aggressive flags (on all tested compilers!!!) - ```-Weverything -pedantic``` for **clang** - ```-Wall -Wextra -pedantic``` and **>> over 35 <<** other warnings **not** covered by these flags for **GCC**!!! - see [**here**](../../scripts/cmake/common.cmake#L84) - ```/Wall``` for **MSVC** (except for: ```C4514```, ```C4571```, ```C4710```, ```C4711```) diff --git a/doc/html_generated/logging.html b/doc/html_generated/logging.html index 6d2dea5..2e60e24 100644 --- a/doc/html_generated/logging.html +++ b/doc/html_generated/logging.html @@ -9,7 +9,7 @@ Additional messages can be logged during a test case (safely even in [**concurre ## INFO() -The ```INFO()``` macro allows heterogenous sequences of expressions to be streamed using the insertion operator (```<<```) in the same way that ```std::ostream```, ```std::cout```, etc support it. +The ```INFO()``` macro allows heterogeneous sequences of expressions to be streamed using the insertion operator (```<<```) in the same way that ```std::ostream```, ```std::cout```, etc support it. ``` INFO("The number is " << i); diff --git a/doc/html_generated/roadmap.html b/doc/html_generated/roadmap.html index d8806a1..00ec0ea 100644 --- a/doc/html_generated/roadmap.html +++ b/doc/html_generated/roadmap.html @@ -148,7 +148,7 @@ Planned features for future releases - order changes constantly... Also look thr - rethink static code analysis suppressions - users shouldn't have to use the same flags for code which uses doctest macros/types - move the "react()" part (the one that throws for REQUIRE asserts - or for when "abort-after=<int>" is reached) to a function call in the while() part of the asserts -- stop using underscores for the begining of identifiers - the anonymous variables - against the standard... +- stop using underscores for the beginning of identifiers - the anonymous variables - against the standard... - templated fixture test cases - test with missed warning flags for GCC - https://github.com/Barro/compiler-warnings diff --git a/doc/markdown/commandline.md b/doc/markdown/commandline.md index 573bf78..4fc1a75 100644 --- a/doc/markdown/commandline.md +++ b/doc/markdown/commandline.md @@ -22,7 +22,7 @@ All the options can also be set with code (defaults/overrides) if the user [**su | ```-lts``` ```--list-test-suites``` | Lists all test suites by name which have at least one test case matching the current filters (see below) | | ```-lr``` ```--list-reporters``` | Lists all registered [**reporters**](reporters.md) | | **Int/String Options** | <hr> | -| ```-tc``` ```--test-case=<filters>``` | Filters test cases based on their name. By default all test cases match but if a value is given to this filter like ```--test-case=*math*,*sound*``` then only test cases who match atleast one of the patterns in the comma-separated list with wildcards will get executed/counted/listed | +| ```-tc``` ```--test-case=<filters>``` | Filters test cases based on their name. By default all test cases match but if a value is given to this filter like ```--test-case=*math*,*sound*``` then only test cases who match at least one of the patterns in the comma-separated list with wildcards will get executed/counted/listed | | ```-tce``` ```--test-case-exclude=<filters>``` | Same as the ```-test-case=<filters>``` option but if any of the patterns in the comma-separated list of values matches - then the test case is skipped | | ```-sf``` ```--source-file=<filters>``` | Same as ```--test-case=<filters>``` but filters based on the file in which test cases are written | | ```-sfe``` ```--source-file-exclude=<filters>``` | Same as ```--test-case-exclude=<filters>``` but filters based on the file in which test cases are written | diff --git a/doc/markdown/faq.md b/doc/markdown/faq.md index 97539d9..363deb9 100644 --- a/doc/markdown/faq.md +++ b/doc/markdown/faq.md @@ -79,7 +79,7 @@ The areas where doctest is behind are planned for improvement in the future. The ### How to get the best compile-time performance with the framework? -The [**```DOCTEST_CONFIG_SUPER_FAST_ASSERTS```**](configuration.md#doctest_config_super_fast_asserts) config option yelds the [**fastest possible**](benchmarks.md#cost-of-an-assertion-macro) compile times (up to 31-91%). Also the expression-decomposing template machinery can be skipped by using the [**binary**](assertions.md#binary-and-unary-asserts) asserts. +The [**```DOCTEST_CONFIG_SUPER_FAST_ASSERTS```**](configuration.md#doctest_config_super_fast_asserts) config option yields the [**fastest possible**](benchmarks.md#cost-of-an-assertion-macro) compile times (up to 31-91%). Also the expression-decomposing template machinery can be skipped by using the [**binary**](assertions.md#binary-and-unary-asserts) asserts. There are only 2 tiny drawbacks of using this config option: diff --git a/doc/markdown/features.md b/doc/markdown/features.md index b3d7266..8137e75 100644 --- a/doc/markdown/features.md +++ b/doc/markdown/features.md @@ -11,7 +11,7 @@ - doesn't drag any headers when included (except for in the translation unit where the library gets implemented) - everything is in the ```doctest``` namespace (and the implementation details are in a nested ```detail``` namespace) - all macros have prefixes - some by default have unprefixed versions as well but that is optional - see [**configuration**](configuration.md) -- 0 warnings even with the most aggresive flags (on all tested compilers!!!) +- 0 warnings even with the most aggressive flags (on all tested compilers!!!) - ```-Weverything -pedantic``` for **clang** - ```-Wall -Wextra -pedantic``` and **>> over 35 <<** other warnings **not** covered by these flags for **GCC**!!! - see [**here**](../../scripts/cmake/common.cmake#L84) - ```/Wall``` for **MSVC** (except for: ```C4514```, ```C4571```, ```C4710```, ```C4711```) diff --git a/doc/markdown/logging.md b/doc/markdown/logging.md index ac5c8d8..a29a56b 100644 --- a/doc/markdown/logging.md +++ b/doc/markdown/logging.md @@ -4,7 +4,7 @@ Additional messages can be logged during a test case (safely even in [**concurre ## INFO() -The ```INFO()``` macro allows heterogenous sequences of expressions to be streamed using the insertion operator (```<<```) in the same way that ```std::ostream```, ```std::cout```, etc support it. +The ```INFO()``` macro allows heterogeneous sequences of expressions to be streamed using the insertion operator (```<<```) in the same way that ```std::ostream```, ```std::cout```, etc support it. ```c++ INFO("The number is " << i); diff --git a/doc/markdown/roadmap.md b/doc/markdown/roadmap.md index 865a7c5..ab7a364 100644 --- a/doc/markdown/roadmap.md +++ b/doc/markdown/roadmap.md @@ -143,7 +143,7 @@ Planned features for future releases - order changes constantly... Also look thr - rethink static code analysis suppressions - users shouldn't have to use the same flags for code which uses doctest macros/types - move the "react()" part (the one that throws for REQUIRE asserts - or for when "abort-after=<int>" is reached) to a function call in the while() part of the asserts -- stop using underscores for the begining of identifiers - the anonymous variables - against the standard... +- stop using underscores for the beginning of identifiers - the anonymous variables - against the standard... - templated fixture test cases - test with missed warning flags for GCC - https://github.com/Barro/compiler-warnings diff --git a/doctest/doctest.h b/doctest/doctest.h index 149bb4a..a1c6df3 100644 --- a/doctest/doctest.h +++ b/doctest/doctest.h @@ -749,7 +749,7 @@ struct ContextOptions //!OCLINT too many fields bool help; // to print the help bool version; // to print the version - bool count; // if only the count of matching tests is to be retreived + bool count; // if only the count of matching tests is to be retrieved bool list_test_cases; // to list all tests matching the filters bool list_test_suites; // to list all suites matching the filters bool list_reporters; // lists all registered reporters @@ -4235,7 +4235,7 @@ namespace detail { const bool isWarn = m_severity & assertType::is_warn; - // warn is just a message in this context so we dont treat it as an assert + // warn is just a message in this context so we don't treat it as an assert if(!isWarn) { addAssert(m_severity); addFailedAssert(m_severity); @@ -5384,7 +5384,7 @@ namespace { // the implementation of parseOption() bool parseOptionImpl(int argc, const char* const* argv, const char* pattern, String* value) { - // going from the end to the begining and stopping on the first occurance from the end + // going from the end to the beginning and stopping on the first occurrence from the end for(int i = argc; i > 0; --i) { auto index = i - 1; auto temp = std::strstr(argv[index], pattern); diff --git a/doctest/parts/doctest.cpp b/doctest/parts/doctest.cpp index 2e153f3..1838b3b 100644 --- a/doctest/parts/doctest.cpp +++ b/doctest/parts/doctest.cpp @@ -1594,7 +1594,7 @@ namespace detail { const bool isWarn = m_severity & assertType::is_warn; - // warn is just a message in this context so we dont treat it as an assert + // warn is just a message in this context so we don't treat it as an assert if(!isWarn) { addAssert(m_severity); addFailedAssert(m_severity); @@ -2743,7 +2743,7 @@ namespace { // the implementation of parseOption() bool parseOptionImpl(int argc, const char* const* argv, const char* pattern, String* value) { - // going from the end to the begining and stopping on the first occurance from the end + // going from the end to the beginning and stopping on the first occurrence from the end for(int i = argc; i > 0; --i) { auto index = i - 1; auto temp = std::strstr(argv[index], pattern); diff --git a/doctest/parts/doctest_fwd.h b/doctest/parts/doctest_fwd.h index 86fcebf..37bb961 100644 --- a/doctest/parts/doctest_fwd.h +++ b/doctest/parts/doctest_fwd.h @@ -746,7 +746,7 @@ struct ContextOptions //!OCLINT too many fields bool help; // to print the help bool version; // to print the version - bool count; // if only the count of matching tests is to be retreived + bool count; // if only the count of matching tests is to be retrieved bool list_test_cases; // to list all tests matching the filters bool list_test_suites; // to list all suites matching the filters bool list_reporters; // lists all registered reporters diff --git a/examples/all_features/test_cases_and_suites.cpp b/examples/all_features/test_cases_and_suites.cpp index db0d7ed..f227479 100644 --- a/examples/all_features/test_cases_and_suites.cpp +++ b/examples/all_features/test_cases_and_suites.cpp @@ -51,7 +51,7 @@ static bool shouldSkip() { return false; } TEST_SUITE("skipped test cases" * doctest::skip()) { TEST_CASE("unskipped" * doctest::skip(shouldSkip()) * - doctest::description("this test has overrided its skip decorator")) { + doctest::description("this test has overridden its skip decorator")) { FAIL(""); } TEST_CASE("skipped - inherited from the test suite") { FAIL(""); } diff --git a/examples/all_features/test_output/filter_2_xml.txt b/examples/all_features/test_output/filter_2_xml.txt index 006aced..8873c22 100644 --- a/examples/all_features/test_output/filter_2_xml.txt +++ b/examples/all_features/test_output/filter_2_xml.txt @@ -101,7 +101,7 @@ <TestCase name="threads..." filename="concurrency.cpp" line="0" skipped="true"/> </TestSuite> <TestSuite name="skipped test cases"> - <TestCase name="unskipped" filename="test_cases_and_suites.cpp" line="0" description="this test has overrided its skip decorator" skipped="true"/> + <TestCase name="unskipped" filename="test_cases_and_suites.cpp" line="0" description="this test has overridden its skip decorator" skipped="true"/> </TestSuite> <TestSuite> <TestCase name="vector stuff<std::vector<int>>" filename="templated_test_cases.cpp" line="0" skipped="true"/> diff --git a/examples/all_features/test_output/order_1.txt b/examples/all_features/test_output/order_1.txt index 6fb2069..acbe5e3 100644 --- a/examples/all_features/test_output/order_1.txt +++ b/examples/all_features/test_output/order_1.txt @@ -28,7 +28,7 @@ test_cases_and_suites.cpp(0): FATAL ERROR: =============================================================================== test_cases_and_suites.cpp(0): -DESCRIPTION: this test has overrided its skip decorator +DESCRIPTION: this test has overridden its skip decorator TEST SUITE: skipped test cases TEST CASE: unskipped diff --git a/examples/all_features/test_output/order_1_xml.txt b/examples/all_features/test_output/order_1_xml.txt index 70ce9e1..7759c95 100644 --- a/examples/all_features/test_output/order_1_xml.txt +++ b/examples/all_features/test_output/order_1_xml.txt @@ -38,7 +38,7 @@ </TestCase> </TestSuite> <TestSuite name="skipped test cases"> - <TestCase name="unskipped" filename="test_cases_and_suites.cpp" line="0" description="this test has overrided its skip decorator"> + <TestCase name="unskipped" filename="test_cases_and_suites.cpp" line="0" description="this test has overridden its skip decorator"> <Message type="FATAL ERROR" filename="test_cases_and_suites.cpp" line="0"> <Text/> </Message> diff --git a/examples/all_features/test_output/order_2.txt b/examples/all_features/test_output/order_2.txt index 6fe76ec..f21deb9 100644 --- a/examples/all_features/test_output/order_2.txt +++ b/examples/all_features/test_output/order_2.txt @@ -88,7 +88,7 @@ test_cases_and_suites.cpp(0): ERROR: test case THREW exception: 0 =============================================================================== test_cases_and_suites.cpp(0): -DESCRIPTION: this test has overrided its skip decorator +DESCRIPTION: this test has overridden its skip decorator TEST SUITE: skipped test cases TEST CASE: unskipped diff --git a/examples/all_features/test_output/order_2_xml.txt b/examples/all_features/test_output/order_2_xml.txt index b5874b8..053bca6 100644 --- a/examples/all_features/test_output/order_2_xml.txt +++ b/examples/all_features/test_output/order_2_xml.txt @@ -95,7 +95,7 @@ </TestCase> </TestSuite> <TestSuite name="skipped test cases"> - <TestCase name="unskipped" filename="test_cases_and_suites.cpp" line="0" description="this test has overrided its skip decorator"> + <TestCase name="unskipped" filename="test_cases_and_suites.cpp" line="0" description="this test has overridden its skip decorator"> <Message type="FATAL ERROR" filename="test_cases_and_suites.cpp" line="0"> <Text/> </Message> diff --git a/examples/all_features/test_output/test_cases_and_suites.cpp.txt b/examples/all_features/test_output/test_cases_and_suites.cpp.txt index a399638..8fbae77 100644 --- a/examples/all_features/test_output/test_cases_and_suites.cpp.txt +++ b/examples/all_features/test_output/test_cases_and_suites.cpp.txt @@ -43,7 +43,7 @@ test_cases_and_suites.cpp(0): MESSAGE: failing because of the timeout decorator! Test case exceeded time limit of 0.000001! =============================================================================== test_cases_and_suites.cpp(0): -DESCRIPTION: this test has overrided its skip decorator +DESCRIPTION: this test has overridden its skip decorator TEST SUITE: skipped test cases TEST CASE: unskipped diff --git a/examples/all_features/test_output/test_cases_and_suites.cpp_xml.txt b/examples/all_features/test_output/test_cases_and_suites.cpp_xml.txt index 4850b72..f13d64c 100644 --- a/examples/all_features/test_output/test_cases_and_suites.cpp_xml.txt +++ b/examples/all_features/test_output/test_cases_and_suites.cpp_xml.txt @@ -58,7 +58,7 @@ </TestCase> </TestSuite> <TestSuite name="skipped test cases"> - <TestCase name="unskipped" filename="test_cases_and_suites.cpp" line="0" description="this test has overrided its skip decorator"> + <TestCase name="unskipped" filename="test_cases_and_suites.cpp" line="0" description="this test has overridden its skip decorator"> <Message type="FATAL ERROR" filename="test_cases_and_suites.cpp" line="0"> <Text/> </Message> diff --git a/scripts/cmake/doctestAddTests.cmake b/scripts/cmake/doctestAddTests.cmake index 3df4076..98ee4a2 100644 --- a/scripts/cmake/doctestAddTests.cmake +++ b/scripts/cmake/doctestAddTests.cmake @@ -54,7 +54,7 @@ foreach(line ${output}) continue() endif() set(test ${line}) - # use escape commas to handle properly test cases with commans inside the name + # use escape commas to handle properly test cases with commas inside the name string(REPLACE "," "\\," test_name ${test}) # ...and add to script add_command(add_test |