Read-only mirrors. Development, issues and pull requests are on GitHub.

summaryrefslogtreecommitdiffhomepage
path: root/docs
diff options
context:
space:
mode:
authorMartin Hořeňovský2019-06-22 20:11:14 +0200
committerMartin Hořeňovský2019-10-29 14:07:18 +0100
commit2bcf1b3db6e1a61328f1efe093d749ef40e0bbd6 (patch)
treed14888a076ac69459f215a0164e86510c133de05 /docs
parentbe44cfa63baf05342d7cea6156504045a56bedf1 (diff)
downloadcatch3-2bcf1b3db6e1a61328f1efe093d749ef40e0bbd6.tar.gz
Remove support for test case descriptions
Closes #1189
Diffstat (limited to 'docs')
-rw-r--r--docs/deprecations.md10
-rw-r--r--docs/release-notes.md2
2 files changed, 2 insertions, 10 deletions
diff --git a/docs/deprecations.md b/docs/deprecations.md
index 8dbb3956..2cf77279 100644
--- a/docs/deprecations.md
+++ b/docs/deprecations.md
@@ -11,16 +11,6 @@ at least the next major release.
## Deprecations
-### Secondary description amongst tags
-
-Currently, the tags part of `TEST_CASE` (and others) macro can also
-contain text that is not part of tags. This text is then separated into
-a "description" of the test case, but the description is then never used
-apart from writing it out for `--list-tests -v high`.
-
-Because it isn't actually used nor documented, and brings complications
-to Catch2's internals, description support will be removed.
-
### SourceLineInfo::empty()
There should be no reason to ever have an empty `SourceLineInfo`, so the
diff --git a/docs/release-notes.md b/docs/release-notes.md
index 08c8a710..8be1bbd5 100644
--- a/docs/release-notes.md
+++ b/docs/release-notes.md
@@ -40,6 +40,8 @@
* `--list*` commands are now piped through the reporters
* The top-level reporter interface provides default implementation that works just as the old one
* XmlReporter outputs a machine-parseable XML
+* `TEST_CASE` description support has been removed
+ * If the second argument has text outside tags, the text will be ignored.
### Fixes
* The `INFO` macro no longer contains superfluous semicolon (#1456)