From 6a422bae0b42313cc6a0f231c89f1b20671cf7f3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Martin=20Ho=C5=99e=C5=88ovsk=C3=BD?= Date: Mon, 17 Oct 2022 15:02:45 +0200 Subject: [PATCH] Trim superfluous whitespace in docs --- docs/Readme.md | 2 +- docs/assertions.md | 14 +++++++------- docs/ci-and-misc.md | 6 +++--- docs/commercial-users.md | 4 ++-- docs/configuration.md | 2 +- docs/contributing.md | 2 +- docs/event-listeners.md | 2 +- docs/matchers.md | 6 +++--- docs/opensource-users.md | 2 +- docs/reporter-events.md | 2 +- docs/test-fixtures.md | 6 +++--- docs/tutorial.md | 4 ++-- 12 files changed, 26 insertions(+), 26 deletions(-) diff --git a/docs/Readme.md b/docs/Readme.md index 4cbcb651..fd3dc126 100644 --- a/docs/Readme.md +++ b/docs/Readme.md @@ -31,7 +31,7 @@ Once you're up and running consider the following reference material. * [CMake integration](cmake-integration.md#top) * [CI and other miscellaneous pieces](ci-and-misc.md#top) * [Known limitations](limitations.md#top) - + **Other:** * [Why Catch2?](why-catch.md#top) * [Migrating from v2 to v3](migrate-v2-to-v3.md#top) diff --git a/docs/assertions.md b/docs/assertions.md index 4a587686..32b079ae 100644 --- a/docs/assertions.md +++ b/docs/assertions.md @@ -19,7 +19,7 @@ Most of these macros come in two forms: The ```REQUIRE``` family of macros tests an expression and aborts the test case if it fails. The ```CHECK``` family are equivalent but execution continues in the same test case even if the assertion fails. This is useful if you have a series of essentially orthogonal assertions and it is useful to see all the results rather than stopping at the first failure. -* **REQUIRE(** _expression_ **)** and +* **REQUIRE(** _expression_ **)** and * **CHECK(** _expression_ **)** Evaluates the expression and records the result. If an exception is thrown, it is caught, reported, and counted as a failure. These are the macros you will use most of the time. @@ -77,22 +77,22 @@ documentation page](comparing-floating-point-numbers.md#top). ## Exceptions -* **REQUIRE_NOTHROW(** _expression_ **)** and +* **REQUIRE_NOTHROW(** _expression_ **)** and * **CHECK_NOTHROW(** _expression_ **)** Expects that no exception is thrown during evaluation of the expression. -* **REQUIRE_THROWS(** _expression_ **)** and +* **REQUIRE_THROWS(** _expression_ **)** and * **CHECK_THROWS(** _expression_ **)** Expects that an exception (of any type) is be thrown during evaluation of the expression. -* **REQUIRE_THROWS_AS(** _expression_, _exception type_ **)** and +* **REQUIRE_THROWS_AS(** _expression_, _exception type_ **)** and * **CHECK_THROWS_AS(** _expression_, _exception type_ **)** Expects that an exception of the _specified type_ is thrown during evaluation of the expression. Note that the _exception type_ is extended with `const&` and you should not include it yourself. -* **REQUIRE_THROWS_WITH(** _expression_, _string or string matcher_ **)** and +* **REQUIRE_THROWS_WITH(** _expression_, _string or string matcher_ **)** and * **CHECK_THROWS_WITH(** _expression_, _string or string matcher_ **)** Expects that an exception is thrown that, when converted to a string, matches the _string_ or _string matcher_ provided (see next section for Matchers). @@ -128,8 +128,8 @@ REQUIRE_NOTHROW([&](){ To support Matchers a slightly different form is used. Matchers have [their own documentation](matchers.md#top). -* **REQUIRE_THAT(** _lhs_, _matcher expression_ **)** and -* **CHECK_THAT(** _lhs_, _matcher expression_ **)** +* **REQUIRE_THAT(** _lhs_, _matcher expression_ **)** and +* **CHECK_THAT(** _lhs_, _matcher expression_ **)** Matchers can be composed using `&&`, `||` and `!` operators. diff --git a/docs/ci-and-misc.md b/docs/ci-and-misc.md index ef9dff24..a4b68ed8 100644 --- a/docs/ci-and-misc.md +++ b/docs/ci-and-misc.md @@ -1,7 +1,7 @@ # CI and other odd pieces -This page talks about how Catch integrates with Continuous Integration +This page talks about how Catch integrates with Continuous Integration Build Systems may refer to low-level tools, like CMake, or larger systems that run on servers, like Jenkins or TeamCity. This page will talk about both. ## Continuous Integration systems @@ -11,9 +11,9 @@ Probably the most important aspect to using Catch with a build server is the use Two of these reporters are built in (XML and JUnit) and the third (TeamCity) is included as a separate header. It's possible that the other two may be split out in the future too - as that would make the core of Catch smaller for those that don't need them. ### XML Reporter -```-r xml``` +```-r xml``` -The XML Reporter writes in an XML format that is specific to Catch. +The XML Reporter writes in an XML format that is specific to Catch. The advantage of this format is that it corresponds well to the way Catch works (especially the more unusual features, such as nested sections) and is a fully streaming format - that is it writes output as it goes, without having to store up all its results before it can start writing. diff --git a/docs/commercial-users.md b/docs/commercial-users.md index bb41e741..020eaefc 100644 --- a/docs/commercial-users.md +++ b/docs/commercial-users.md @@ -6,7 +6,7 @@ some of them that are willing to share this information. If you want to add your organisation, please check that there is no issue with you sharing this fact. - + - Bloomberg - [Bloomlife](https://bloomlife.com) - [Inscopix Inc.](https://www.inscopix.com/) @@ -16,7 +16,7 @@ with you sharing this fact. - [Nexus Software Systems](https://nexwebsites.com) - [UX3D](https://ux3d.io) - [King](https://king.com) - + --- diff --git a/docs/configuration.md b/docs/configuration.md index d24455ea..59861b4a 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -98,7 +98,7 @@ is equivalent with the out-of-the-box experience. ## Bazel support -When `CATCH_CONFIG_BAZEL_SUPPORT` is defined or when `BAZEL_TEST=1` (which is set by the Bazel inside of a test environment), +When `CATCH_CONFIG_BAZEL_SUPPORT` is defined or when `BAZEL_TEST=1` (which is set by the Bazel inside of a test environment), Catch2 will register a `JUnit` reporter writing to a path pointed by `XML_OUTPUT_FILE` provided by Bazel. > `CATCH_CONFIG_BAZEL_SUPPORT` was [introduced](https://github.com/catchorg/Catch2/pull/2399) in Catch2 3.0.1. diff --git a/docs/contributing.md b/docs/contributing.md index dab39198..a0121da5 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -125,7 +125,7 @@ information that you will need for updating Catch2's documentation, and possibly some generic advise as well. -### Technicalities +### Technicalities First, the technicalities: diff --git a/docs/event-listeners.md b/docs/event-listeners.md index 9b706948..71db3e18 100644 --- a/docs/event-listeners.md +++ b/docs/event-listeners.md @@ -33,7 +33,7 @@ public: CATCH_REGISTER_LISTENER(testRunListener) ``` -_Note that you should not use any assertion macros within a Listener!_ +_Note that you should not use any assertion macros within a Listener!_ [You can find the list of events that the listeners can react to on its own page](reporter-events.md#top). diff --git a/docs/matchers.md b/docs/matchers.md index ec4728da..d3afe0f4 100644 --- a/docs/matchers.md +++ b/docs/matchers.md @@ -241,12 +241,12 @@ in which case a range is accepted if any of its elements is accepted by the provided matcher. `AllMatch`, `NoneMatch`, and `AnyMatch` match ranges for which either -all, none, or any of the contained elements matches the given matcher, +all, none, or any of the contained elements matches the given matcher, respectively. `AllTrue`, `NoneTrue`, and `AnyTrue` match ranges for which either -all, none, or any of the contained elements are `true`, respectively. -It works for ranges of `bool`s and ranges of elements (explicitly) +all, none, or any of the contained elements are `true`, respectively. +It works for ranges of `bool`s and ranges of elements (explicitly) convertible to `bool`. ## Writing custom matchers (old style) diff --git a/docs/opensource-users.md b/docs/opensource-users.md index c65f7185..12b4551c 100644 --- a/docs/opensource-users.md +++ b/docs/opensource-users.md @@ -72,7 +72,7 @@ A header-only template engine for modern C++. A C++17 template header-only library for the abstraction of memory access patterns. ### [libcluon](https://github.com/chrberger/libcluon) -A single-header-only library written in C++14 to glue distributed software components (UDP, TCP, shared memory) supporting natively Protobuf, LCM/ZCM, MsgPack, and JSON for dynamic message transformations in-between. +A single-header-only library written in C++14 to glue distributed software components (UDP, TCP, shared memory) supporting natively Protobuf, LCM/ZCM, MsgPack, and JSON for dynamic message transformations in-between. ### [MNMLSTC Core](https://github.com/mnmlstc/core) A small and easy to use C++11 library that adds a functionality set that will be available in C++14 and later, as well as some useful additions. diff --git a/docs/reporter-events.md b/docs/reporter-events.md index 7adae53c..32a0ae50 100644 --- a/docs/reporter-events.md +++ b/docs/reporter-events.md @@ -138,7 +138,7 @@ benchmarking itself fails. > Introduced in Catch2 3.0.1. Listings events are events that correspond to the test binary being -invoked with `--list-foo` flag. +invoked with `--list-foo` flag. There are currently 3 listing events, one for reporters, one for tests, and one for tags. Note that they are not exclusive to each other. diff --git a/docs/test-fixtures.md b/docs/test-fixtures.md index 21e4ea31..9c9eaa18 100644 --- a/docs/test-fixtures.md +++ b/docs/test-fixtures.md @@ -130,9 +130,9 @@ struct Template_Foo_2 { }; TEMPLATE_PRODUCT_TEST_CASE_METHOD_SIG( - Template_Fixture_2, - "A TEMPLATE_PRODUCT_TEST_CASE_METHOD_SIG based test run that succeeds", - "[class][template][product][nttp]", + Template_Fixture_2, + "A TEMPLATE_PRODUCT_TEST_CASE_METHOD_SIG based test run that succeeds", + "[class][template][product][nttp]", ((typename T, size_t S), T, S), (std::array, Template_Foo_2), ((int,2), (float,6))) { diff --git a/docs/tutorial.md b/docs/tutorial.md index 9216e9fd..342c7381 100644 --- a/docs/tutorial.md +++ b/docs/tutorial.md @@ -100,7 +100,7 @@ before we move on. It accepts a boolean expression, and uses expression templates to internally decompose it, so that it can be individually stringified on test failure. - + On the last point, note that there are more testing macros available, because not all useful checks can be expressed as a simple boolean expression. As an example, checking that an expression throws an exception @@ -178,7 +178,7 @@ To continue on the vector example above, you could add a check that } ``` -Another way to look at sections is that they are a way to define a tree +Another way to look at sections is that they are a way to define a tree of paths through the test. Each section represents a node, and the final tree is walked in depth-first manner, with each path only visiting only one leaf node.