Reorganize changes doc + Tweak main /docs

This commit is contained in:
Mike Thompson 2017-07-23 22:58:52 +10:00
parent e6d87cf7a8
commit 5a2bcac347
2 changed files with 14 additions and 13 deletions

View File

@ -1,24 +1,25 @@
## Unreleased ## Unreleased
#### New
- added [an API document](/docs/API.md)
- added [testing docs](/docs/Testing.md)
- added [a new mental model](/docs/MentalModelOmnibus.md#on-dsls-and-machines)
- added [a new FAQ entry](docs/FAQs/When-Does-Dispatch-Happen.md) on dispatch processing
- The effect handler for `:dispatch-n` will now ignore `nils`. [See checkin](https://github.com/Day8/re-frame/commit/6efdae438f393f8121a2d6dfbf76db00e6dafbf5)
#### Breaking #### Breaking
- [#357](https://github.com/Day8/re-frame/pull/357) - [#357](https://github.com/Day8/re-frame/pull/357)
I'd be amazed if this actually broke any apps. Shocked. But for completeness ... the I'd be amazed if this actually broke any apps. Shocked! But, better safe than sorry.
effect handler for `:db` has been changed. If the provided value tests The effect handler for `:db` has changed: if the value provided tests
`identical?` to the current value within `app-db` then `app-db` is not `reset!`. `identical?` to the existing value within `app-db`, then `app-db` is not `reset!`.
Previously, `app-db` was always `reset!` when a `:db` effect was supplied, Previously, `app-db` was always `reset!` when a `:db` effect was supplied,
which caused Layer 2 subscriptions to run unnecessarily. So this is a tiny which caused Layer 2 subscriptions to run unnecessarily. So this is a tiny
efficiency change which also results in behaviour that better matches efficiency change in an edge case, which also results in behaviour that better matches
programmer intuitions. programmer intuitions.
#### New #### Minor Fixes and Improvements
- added [testing docs](/docs/Testing.md)
- added [a new mental model](/docs/MentalModelOmnibus.md#on-dsls-and-machines)
- added [a new FAQ](docs/FAQs/When-Does-Dispatch-Happen.md) on dispatch processing
- The effect `:dispatch-n` will now ignore `nils` which can be useful. [See checkin](https://github.com/Day8/re-frame/commit/6efdae438f393f8121a2d6dfbf76db00e6dafbf5)
#### Fixes and Improvements
- [#340](https://github.com/Day8/re-frame/pull/340) - [#340](https://github.com/Day8/re-frame/pull/340)
- [#341](https://github.com/Day8/re-frame/pull/341) Fix `re-frame.std-interceptors/on-changes` to work even if effect handler does not set `:db`. - [#341](https://github.com/Day8/re-frame/pull/341) Fix `re-frame.std-interceptors/on-changes` to work even if effect handler does not set `:db`.

View File

@ -11,7 +11,7 @@
- [purelyfunctional.tv](https://purelyfunctional.tv/guide/re-frame-building-blocks/) - a detailed, well written introduction. - [purelyfunctional.tv](https://purelyfunctional.tv/guide/re-frame-building-blocks/) - a detailed, well written introduction.
- [Lambda Island Videos](https://lambdaisland.com/episodes) - commercial videos on many clojure topics, including re-frame and reagent. - [Lambda Island Videos](https://lambdaisland.com/episodes) - commercial videos on many clojure topics, including re-frame and reagent.
### Domaino 2 - Event Handlers ### Dominoes 2 and 3 - Event Handlers
- [Infographic Overview](EventHandlingInfographic.md) - [Infographic Overview](EventHandlingInfographic.md)
- [Effectful Handlers](EffectfulHandlers.md) - [Effectful Handlers](EffectfulHandlers.md)