3rd-party
/
catch2
mirror of https://github.com/catchorg/Catch2.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
catch2/docs/deprecations.md

32 lines
940 B
Markdown
Raw Normal View History

Add deprecations documentation
2018-11-17 11:01:29 +01:00
<a id="top"></a>
# Deprecations and incoming changes
Turn "deprecations" into "deprecations and planned changes" This captures the intent better, as some changes are indeed plain deprecations leading to removal, but other changes can be viewed as minor tune-ups instead.
2018-11-24 18:01:20 +01:00
This page documents current deprecations and upcoming planned changes
inside Catch2. The difference between these is that a deprecated feature
will be removed, while a planned change to a feature means that the
feature will behave differently, but will still be present. Obviously,
either of these is a breaking change, and thus will not happen until
at least the next major release.
Add deprecations documentation
2018-11-17 11:01:29 +01:00
Fix significant bug with storing composed matchers Given that in the 2 or so years that matchers are thing nobody complained, it seems that people do not actually write this sort of code, and the possibility will be removed in v3. However, to avoid correctness bugs, we will have to support this weird code in v2.
2020-02-01 20:55:42 +01:00
Turn "deprecations" into "deprecations and planned changes" This captures the intent better, as some changes are indeed plain deprecations leading to removal, but other changes can be viewed as minor tune-ups instead.
2018-11-24 18:01:20 +01:00
## Planned changes
Add more deprecations
2018-11-17 21:13:56 +01:00
Turn "deprecations" into "deprecations and planned changes" This captures the intent better, as some changes are indeed plain deprecations leading to removal, but other changes can be viewed as minor tune-ups instead.
2018-11-24 18:01:20 +01:00
### `CHECKED_IF` and `CHECKED_ELSE`
To make the `CHECKED_IF` and `CHECKED_ELSE` macros more useful, they will
be marked as "OK to fail" (`Catch::ResultDisposition::SuppressFail` flag
will be added), which means that their failure will not fail the test,
making the `else` actually useful.
Fix colourized output to file This change should be backwards compatible, but it would be better to make the console colour API take an argument in the long term. Fixes #1502
2019-01-19 13:29:53 +01:00
### Console Colour API
The API for Catch2's console colour will be changed to take an extra
argument, the stream to which the colour code should be applied.
Mark type erasure in PredicateFunction as deprecated
2019-10-28 15:14:54 +01:00
Add deprecations documentation
2018-11-17 11:01:29 +01:00
---
[Home](Readme.md#top)