Skip to content

Commit

Permalink
Merge pull request #97 from ShikaSD/1.2.0-actually-update-docs
Browse files Browse the repository at this point in the history
Add what's new section for 1.2.0
  • Loading branch information
zsoltk authored Jul 22, 2019
2 parents 4981cba + 50ee9df commit 90f821b
Show file tree
Hide file tree
Showing 5 changed files with 31 additions and 5 deletions.
2 changes: 1 addition & 1 deletion documentation/extras/modelwatcher.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## Efficient view updates
# Efficient view updates

MVICore includes utility class to observe difference in the received models and prevent redundant view updates.

Expand Down
2 changes: 1 addition & 1 deletion documentation/extras/ttdui.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## Time Travel Debugger UI controls
# Time Travel Debugger UI controls

If you are on Android and using [DebugDrawer](https://github.com/palaima/DebugDrawer), you can find a UI control module you can add to it in the `mvicore-debugdrawer` dependency.

Expand Down
4 changes: 1 addition & 3 deletions documentation/features/reducerfeature.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Invocations of the reducer must always happen on the same thread to ensure that
!!! warning ""
If two threads were to read State<sup>n</sup>, then apply some `Effect` over it, one would derive State<sup>n+1'</sup>, while the other would derive State<sup>n+1''</sup> from it, and depending on the order of execution, one or the other would be lost. By enforcing the single-thread policy, all `Effect`s are always applied to the latest state.

## Excercise #1
## Exercise #1
### Task
- Let's store a counter in our state
- Let's make it possible to increment this counter by a `Wish`
Expand Down Expand Up @@ -55,8 +55,6 @@ class Feature1 : ReducerFeature<Wish, State, Nothing>(
}
```



Under the hood, `ReducerFeature` is a subclass of `BaseFeature` giving you a subset of all the possibilities there.

It will also wire everything up for you (reacting to a `Wish`, calling your `Reducer`, emitting your next `State`).
Expand Down
27 changes: 27 additions & 0 deletions documentation/whatsnew.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
## Changelog

### 1.2.0

#### API changes

([#66](https://github.com/badoo/MVICore/pull/66)):
`Connection` is updated to provide information about both `ObservableSource` and `Consumer` types.
`ConsumerMiddleware<In>` is replaced by `Middleware<Out, In>` to provide access to both input and output types of the `Connection`.

#### Additions

([#73](https://github.com/badoo/MVICore/pull/73)):
Allows transformer to access to the stream between `Source` and `Consumer`. See more details in
[advanced binder](../binder/binder-advanced/#changing-reactive-chain-between-input-and-output) section.

([#76](https://github.com/badoo/MVICore/pull/76)):
`MemoFeature` which keeps latest accepted state.

([#82](https://github.com/badoo/MVICore/pull/82)):
Organized way of diffing fields in model to provide more efficient view updates. More information [here](../extras/modelwatcher/).

([#77](https://github.com/badoo/MVICore/pull/77)):
Idea plugin to observe elements of connections based on middlewares. Read about it [here](../extras/intellijplugin/#android-studio-plugin-to-observe-elements-of-connections).



1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ docs_dir: documentation

nav:
- Overview: index.md
- What's new: whatsnew.md
- Features:
- Core concepts: features/coreconcepts.md
- Your first and simplest feature: features/reducerfeature.md
Expand Down

0 comments on commit 90f821b

Please sign in to comment.