diff options
| author | Allan Wang <me@allanwang.ca> | 2020-02-23 13:14:41 -0800 |
|---|---|---|
| committer | Allan Wang <me@allanwang.ca> | 2020-02-23 13:14:41 -0800 |
| commit | b35098bafd923d44bf751df2fce5f24cdad6f54b (patch) | |
| tree | 05b0f332f12a487e81079a8dd60f5eb250d78005 | |
| parent | d67d4a1204796377040a1769175d5798ce09408b (diff) | |
| download | kau-b35098bafd923d44bf751df2fce5f24cdad6f54b.tar.gz kau-b35098bafd923d44bf751df2fce5f24cdad6f54b.tar.bz2 kau-b35098bafd923d44bf751df2fce5f24cdad6f54b.zip | |
Update docs
| -rw-r--r-- | docs/Changelog.md | 3 | ||||
| -rw-r--r-- | docs/Migration.md | 12 | ||||
| -rw-r--r-- | sample/src/main/res/xml/kau_changelog.xml | 4 |
3 files changed, 16 insertions, 3 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 diff --git a/sample/src/main/res/xml/kau_changelog.xml b/sample/src/main/res/xml/kau_changelog.xml index d61fe63..55adabc 100644 --- a/sample/src/main/res/xml/kau_changelog.xml +++ b/sample/src/main/res/xml/kau_changelog.xml @@ -6,9 +6,9 @@ <item text="" /> --> - <version title="v5.2.1" /> + <version title="v5.3.0" /> <item text=":color: Allow option to disable selected ring" /> - <item text="" /> + <item text=":core: Breaking KPref changes; see migration" /> <item text="" /> <item text="" /> |