diff options
| author | Julien Brianceau | 2021-04-07 20:43:50 +0200 |
|---|---|---|
| committer | GitHub | 2021-04-07 20:43:50 +0200 |
| commit | e8cdfdca87ebacd993befdd08ea6aa7e8068ef3d (patch) | |
| tree | 9342e9569feb9178b600d6b95cb1f7d7ed380861 /docs | |
| parent | a5abec9cb5d7a26b94d3da24fd239c28ac2dbf91 (diff) | |
| download | catch3-e8cdfdca87ebacd993befdd08ea6aa7e8068ef3d.tar.gz | |
Fix typos in the code base (#2206)
Note that only documentation and comments are impacted by this change.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/contributing.md | 2 | ||||
| -rw-r--r-- | docs/matchers.md | 2 | ||||
| -rw-r--r-- | docs/release-notes.md | 2 |
3 files changed, 3 insertions, 3 deletions
diff --git a/docs/contributing.md b/docs/contributing.md index 5251b33d..9a85f76a 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -26,7 +26,7 @@ Ongoing development happens in the `devel` branch for Catch2 v3, and in Commits should be small and atomic. A commit is atomic when, after it is applied, the codebase, tests and all, still works as expected. Small -commits are also prefered, as they make later operations with git history, +commits are also preferred, as they make later operations with git history, whether it is bisecting, reverting, or something else, easier. _When submitting a pull request please do not include changes to the diff --git a/docs/matchers.md b/docs/matchers.md index 92070765..35515889 100644 --- a/docs/matchers.md +++ b/docs/matchers.md @@ -101,7 +101,7 @@ string is equal to `str`. Finally, the `Matches` matcher performs an ECMASCript regex match using `str` against the argument string. It is important to know that -the match is performed agains the string as a whole, meaning that +the match is performed against the string as a whole, meaning that the regex `"abc"` will not match input string `"abcd"`. To match `"abcd"`, you need to use e.g. `"abc.*"` as your regex. diff --git a/docs/release-notes.md b/docs/release-notes.md index a3893589..034df174 100644 --- a/docs/release-notes.md +++ b/docs/release-notes.md @@ -74,7 +74,7 @@ new design. * Will Catch2 again distribute single-header version in the future? * No. But we do provide sqlite-style amalgamated distribution option. This means that you can download just 1 .cpp file and 1 header and place them next to your own sources. However, doing this has downsides similar to using the `catch_all.hpp` header. * Why the big breaking change caused by replacing `catch.hpp` with `catch_all.hpp`? - * The convenience header `catch_all.hpp` exists for two reasons. One of them is to provide a way for quick migration from Catch2, the second one is to provide a simple way to test things with Catch2. Using it for migration has one drawback in that it is **big**. This means that including it _will_ cause significant compile time drag, and so using it to migrate should be a concious decision by the user, not something they can just stumble into unknowingly. + * The convenience header `catch_all.hpp` exists for two reasons. One of them is to provide a way for quick migration from Catch2, the second one is to provide a simple way to test things with Catch2. Using it for migration has one drawback in that it is **big**. This means that including it _will_ cause significant compile time drag, and so using it to migrate should be a conscious decision by the user, not something they can just stumble into unknowingly. ### (Potentially) Breaking changes |