2018-11-17 11:01:29 +01:00
|
|
|
<a id="top"></a>
|
|
|
|
|
# Deprecations and incoming changes
|
|
|
|
|
|
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.
|
2018-11-17 11:01:29 +01:00
|
|
|
|
|
|
|
|
|
2018-11-24 18:01:20 +01:00
|
|
|
## Deprecations
|
2018-11-17 11:01:29 +01:00
|
|
|
|
2019-09-08 18:20:49 +02:00
|
|
|
### SourceLineInfo::empty()
|
|
|
|
|
|
|
|
|
|
There should be no reason to ever have an empty `SourceLineInfo`, so the
|
|
|
|
|
method will be removed.
|
|
|
|
|
|
2018-11-17 11:01:29 +01:00
|
|
|
|
2018-11-24 18:01:20 +01:00
|
|
|
## Planned changes
|
2018-11-17 21:13:56 +01:00
|
|
|
|
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.
|
|
|
|
|
|
|
|
|
|
|
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.
|
|
|
|
|
|
2019-10-28 15:14:54 +01:00
|
|
|
|
2018-11-17 11:01:29 +01:00
|
|
|
---
|
|
|
|
|
|
|
|
|
|
[Home](Readme.md#top)
|
