Skip to content

[shared_preferences] Fix confusing language in README #8049

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Nov 9, 2024
Merged

[shared_preferences] Fix confusing language in README #8049

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d97a6fb
[shared_preferences] Fix confusing language in README
stuartmorgan-g Nov 8, 2024
f85551b
Version bump
stuartmorgan-g Nov 8, 2024
63c21d4
README
stuartmorgan-g Nov 8, 2024
e52f309
Clarify scope in legacy class doc comment
stuartmorgan-g Nov 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions packages/shared_preferences/shared_preferences/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
## 2.3.3

* Clarifies scope of prefix handling in README.

## 2.3.2

* Removes outdated testing information from README.
Expand Down
2 changes: 1 addition & 1 deletion packages/shared_preferences/shared_preferences/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
3 changes: 2 additions & 1 deletion packages/shared_preferences/shared_preferences/lib/src/shared_preferences_legacy.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion packages/shared_preferences/shared_preferences/pubspec.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down