- Add docstrings

- Prep for 0.2.3 release
nwithan8 · Feb 10, 2023 · d5917c5 · d5917c5
1 parent 90e3128
commit d5917c5
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 0 deletions.
diff --git 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
@@ -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
@@ -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(