From d97a6fb805809abdb0855b8315bf76bbe2604ed3 Mon Sep 17 00:00:00 2001 From: stuartmorgan Date: Fri, 8 Nov 2024 18:50:22 -0500 Subject: [PATCH 1/4] [shared_preferences] Fix confusing language in README One use of "class" instead of "plugin" to refer to the `SharedPreferences` class specifically slipped through review. This updates it to make it clear that it's talking about a specific class, not the plugin. --- packages/shared_preferences/shared_preferences/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/shared_preferences/shared_preferences/README.md b/packages/shared_preferences/shared_preferences/README.md index 520de19323c..bd9fd06dbc9 100644 --- a/packages/shared_preferences/shared_preferences/README.md +++ b/packages/shared_preferences/shared_preferences/README.md @@ -160,7 +160,7 @@ A tool to make this process easier can be tracked here: https://github.com/flutt #### Adding, Removing, or changing prefixes on SharedPreferences -By default, the `SharedPreferences` plugin will only read (and write) preferences +By default, the `SharedPreferences` class will only read (and write) preferences that begin with the prefix `flutter.`. This is all handled internally by the plugin and does not require manually adding this prefix. From f85551b153d1e514b27b0e9782a7ed7575efbfda Mon Sep 17 00:00:00 2001 From: stuartmorgan Date: Fri, 8 Nov 2024 18:51:28 -0500 Subject: [PATCH 2/4] Version bump --- packages/shared_preferences/shared_preferences/pubspec.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/shared_preferences/shared_preferences/pubspec.yaml b/packages/shared_preferences/shared_preferences/pubspec.yaml index cbe53e8d2be..6c715ff7e3a 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.3.2 +version: 2.3.3 environment: sdk: ^3.4.0 From 63c21d4def1f2fc987141be31c9bc47d9e7236df Mon Sep 17 00:00:00 2001 From: stuartmorgan Date: Fri, 8 Nov 2024 18:52:01 -0500 Subject: [PATCH 3/4] README --- packages/shared_preferences/shared_preferences/CHANGELOG.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/packages/shared_preferences/shared_preferences/CHANGELOG.md b/packages/shared_preferences/shared_preferences/CHANGELOG.md index 717cfdcd80d..81708ac6532 100644 --- a/packages/shared_preferences/shared_preferences/CHANGELOG.md +++ b/packages/shared_preferences/shared_preferences/CHANGELOG.md @@ -1,3 +1,7 @@ +## 2.3.3 + +* Clarifies scope of prefix handling in README. + ## 2.3.2 * Removes outdated testing information from README. From e52f309e66e947dd73a60839d4cce653d8d00681 Mon Sep 17 00:00:00 2001 From: stuartmorgan Date: Fri, 8 Nov 2024 18:54:37 -0500 Subject: [PATCH 4/4] Clarify scope in legacy class doc comment --- .../shared_preferences/lib/src/shared_preferences_legacy.dart | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/packages/shared_preferences/shared_preferences/lib/src/shared_preferences_legacy.dart b/packages/shared_preferences/shared_preferences/lib/src/shared_preferences_legacy.dart index a7eccb16950..72deffe5fe9 100644 --- a/packages/shared_preferences/shared_preferences/lib/src/shared_preferences_legacy.dart +++ b/packages/shared_preferences/shared_preferences/lib/src/shared_preferences_legacy.dart @@ -28,7 +28,8 @@ class SharedPreferences { static SharedPreferencesStorePlatform get _store => SharedPreferencesStorePlatform.instance; - /// Sets the prefix that is attached to all keys for all shared preferences. + /// Sets the prefix that is attached to all keys for all shared preferences + /// read or written via this class. /// /// This changes the inputs when adding data to preferences as well as /// setting the filter that determines what data will be returned