From f89e40880247be279f1e352afab68f58224d87e5 Mon Sep 17 00:00:00 2001 From: Nikolas Rimikis <25266387+Leptopoda@users.noreply.github.com> Date: Tue, 10 Oct 2023 21:54:57 +0200 Subject: [PATCH] [shared_preferences] fix documentation wording (#4986) The wording of the `SharedPreferences.containsKey` docs was off. This PR improves the documentation. none. I can open an issue if really necessary. n.a. --- packages/shared_preferences/shared_preferences/CHANGELOG.md | 4 ++++ .../shared_preferences/lib/shared_preferences.dart | 2 +- packages/shared_preferences/shared_preferences/pubspec.yaml | 2 +- 3 files changed, 6 insertions(+), 2 deletions(-) diff --git a/packages/shared_preferences/shared_preferences/CHANGELOG.md b/packages/shared_preferences/shared_preferences/CHANGELOG.md index dc935cfdddc..6d0094549f8 100644 --- a/packages/shared_preferences/shared_preferences/CHANGELOG.md +++ b/packages/shared_preferences/shared_preferences/CHANGELOG.md @@ -1,3 +1,7 @@ +## 2.2.2 + +* Updates documentation for `containsKey`. + ## 2.2.1 * Adds pub topics to package metadata. diff --git a/packages/shared_preferences/shared_preferences/lib/shared_preferences.dart b/packages/shared_preferences/shared_preferences/lib/shared_preferences.dart index 6164f1bb242..7361758b99d 100644 --- a/packages/shared_preferences/shared_preferences/lib/shared_preferences.dart +++ b/packages/shared_preferences/shared_preferences/lib/shared_preferences.dart @@ -121,7 +121,7 @@ class SharedPreferences { /// String. String? getString(String key) => _preferenceCache[key] as String?; - /// Returns true if persistent storage the contains the given [key]. + /// Returns true if the persistent storage contains the given [key]. bool containsKey(String key) => _preferenceCache.containsKey(key); /// Reads a set of string values from persistent storage, throwing an diff --git a/packages/shared_preferences/shared_preferences/pubspec.yaml b/packages/shared_preferences/shared_preferences/pubspec.yaml index 39bcf9282a2..3b8b8b34519 100644 --- a/packages/shared_preferences/shared_preferences/pubspec.yaml +++ b/packages/shared_preferences/shared_preferences/pubspec.yaml @@ -3,7 +3,7 @@ description: Flutter plugin for reading and writing simple key-value pairs. Wraps NSUserDefaults on iOS and SharedPreferences on Android. repository: https://github.com/flutter/packages/tree/main/packages/shared_preferences/shared_preferences issue_tracker: https://github.com/flutter/flutter/issues?q=is%3Aissue+is%3Aopen+label%3A%22p%3A+shared_preferences%22 -version: 2.2.1 +version: 2.2.2 environment: sdk: ">=2.19.0 <4.0.0"