From d5917c5ef0a4d8fe55929a95f9a742472037dc59 Mon Sep 17 00:00:00 2001 From: nharris Date: Fri, 10 Feb 2023 16:16:19 -0700 Subject: [PATCH] - Add docstrings - Prep for 0.2.3 release --- CHANGELOG.md | 10 ++++++++++ lib/src/defaults.dart | 1 + lib/src/expiration_actions.dart | 1 + 3 files changed, 12 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 19b2f6a..3e535f7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,17 +1,27 @@ +## 0.2.3 (2023-02-10) + +- [ADDED] Docstring improvements +- [ADDED] `Censors.defaultCredentialCensors` to get a pre-configured Censors object for censoring common credentials + ## 0.2.2 (2023-01-31) + - [ADDED] Docstring improvements - [CHANGED] Formatting improvements ## 0.2.1 (2023-01-30) + - [ADDED] Docstring improvements ## 0.2.0 (2022-12-30) + - [FIXED] Fixed a bug that failed to apply censors to recorded data. ## 0.1.1 (2022-12-12) + - [ADDED] Documentation to README.md - [CHANGED] `AdvancedSettings` now named `AdvancedOptions` - [CHANGED] `EasyVCRClient` now named `DartVCRClient` ## 0.1.0 (2022-12-01) + - Initial release diff --git a/lib/src/defaults.dart b/lib/src/defaults.dart index fc3ebb0..73ec969 100644 --- a/lib/src/defaults.dart +++ b/lib/src/defaults.dart @@ -1,3 +1,4 @@ +/// The header added to all requests recorded by the VCR, for detecting if a response came from a recording or not. const String viaRecordingHeaderKey = "X-Via-DartVCR-Recording"; /// A set of default headers that will be added to all requests replayed by the VCR. diff --git a/lib/src/expiration_actions.dart b/lib/src/expiration_actions.dart index 48e896a..a7b029d 100644 --- a/lib/src/expiration_actions.dart +++ b/lib/src/expiration_actions.dart @@ -16,6 +16,7 @@ enum ExpirationAction { /// An extension on [ExpirationAction] that provides additional functionality. extension ExpirationActionExtension on ExpirationAction { + /// Check if the given [action] and [mode] are compatible. void checkCompatibleSettings(ExpirationAction action, Mode mode) { if (action == ExpirationAction.recordAgain && mode == Mode.replay) { throw VCRException(