aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorAllan Wang <me@allanwang.ca>2020-02-23 15:28:20 -0800
committerGitHub <noreply@github.com>2020-02-23 15:28:20 -0800
commit3fa13a3a84d34fd0d96f26d6c5dea0e0671dd6c4 (patch)
tree4e3f13ac9eafdfd02f4f0f78e0d7575f8bea0bf5 /docs
parent0e4e82933001ab749538109210cb0940ea912db0 (diff)
parent0e7e43f7f778a206b0b30c6997c7c36494e6c142 (diff)
downloadkau-3fa13a3a84d34fd0d96f26d6c5dea0e0671dd6c4.tar.gz
kau-3fa13a3a84d34fd0d96f26d6c5dea0e0671dd6c4.tar.bz2
kau-3fa13a3a84d34fd0d96f26d6c5dea0e0671dd6c4.zip
Merge pull request #248 from AllanWang/kpref
Kpref
Diffstat (limited to 'docs')
-rw-r--r--docs/Changelog.md3
-rw-r--r--docs/Migration.md12
2 files changed, 14 insertions, 1 deletions
diff --git a/docs/Changelog.md b/docs/Changelog.md
index feb5e4a..576ac96 100644
--- a/docs/Changelog.md
+++ b/docs/Changelog.md
@@ -1,7 +1,8 @@
# Changelog
-## v5.2.1
+## v5.3.0
* :color: Allow option to disable selected ring
+* :core: Breaking KPref changes; see migration
## v5.2.0
* :about: Migrate about libraries to v7.x.x
diff --git a/docs/Migration.md b/docs/Migration.md
index fb29f7b..b0d0079 100644
--- a/docs/Migration.md
+++ b/docs/Migration.md
@@ -2,6 +2,18 @@
Below are some highlights on major refactoring/breaking changes
+# v5.2.0
+
+## KPref
+
+In an effort to improve testing options, KPref has some updates to allow for in memory preferences during unit tests.
+While you can still use KPref like before as an object (provide the `KPrefFactoryAndroid` factory),
+it is recommended that you use some sort of dependency injection/service locator to provide the factory.
+An example can be found in the sample app test class.
+
+Also note that to better support in memory preferences, `reset()` will clear the in memory content for both variants,
+meaning that in memory preferences will reset to default. Previously, in memory `reset()` did nothing.
+
# v5.1.0
## KPref