Skip to content

Commit ba58c7e

Browse files
committed
update changes section of readme
1 parent 5efb6f8 commit ba58c7e

File tree

1 file changed

+25
-23
lines changed

1 file changed

+25
-23
lines changed

README.md

Lines changed: 25 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -67,29 +67,31 @@ Version 0.10 of Scenic contains both deprecations and breaking changes, which wi
6767

6868
### Deprecations
6969

70-
* `push_graph/1` is deprecated in favor of returning `{:push, graph}`
71-
([keyword](https://hexdocs.pm/elixir/Keyword.html)) options
72-
from the `Scenic.Scene` callbacks. Since this is only a deprecation `push_graph/1` will
73-
continue to work, but will log a warning when used. `push_graph/1` will be removed in a
74-
future release.
75-
* This allows us to utilize the full suite of OTP GenServer callback behaviors (such as
76-
timeout and `handle_continue`)
77-
* Replacing the call of `push_graph(graph)` within a callback function depends slightly
78-
on the context in which it is used.
79-
* in `init/2`:
80-
* `{:ok, state, [push: graph]}`
81-
* in `filter_event/3`:
82-
* `{:halt, state, [push: graph]}`
83-
* `{:cont, event, state, [push: graph]}`
84-
* in `handle_cast/2`:
85-
* `{:noreply, state, [push: graph]}`
86-
* in `handle_info/2`:
87-
* `{:noreply, state, [push: graph]}`
88-
* in `handle_call/3`:
89-
* `{:reply, reply, state, [push: graph]}`
90-
* `{:noreply, state, [push: graph]}`
91-
* in `handle_continue/3`:
92-
* `{:noreply, state, [push: graph]}`
70+
`push_graph/1` is deprecated in favor of returning `{:push, graph}`
71+
([keyword](https://hexdocs.pm/elixir/Keyword.html)) options
72+
from the `Scenic.Scene` callbacks. Since this is only a deprecation `push_graph/1` will
73+
continue to work, but will log a warning when used.
74+
75+
`push_graph/1` will be removed in a future release.
76+
77+
* This allows us to utilize the full suite of OTP GenServer callback behaviors (such as
78+
timeout and `handle_continue`)
79+
* Replacing the call of `push_graph(graph)` within a callback function depends slightly
80+
on the context in which it is used.
81+
* in `init/2`:
82+
* `{:ok, state, [push: graph]}`
83+
* in `filter_event/3`:
84+
* `{:halt, state, [push: graph]}`
85+
* `{:cont, event, state, [push: graph]}`
86+
* in `handle_cast/2`:
87+
* `{:noreply, state, [push: graph]}`
88+
* in `handle_info/2`:
89+
* `{:noreply, state, [push: graph]}`
90+
* in `handle_call/3`:
91+
* `{:reply, reply, state, [push: graph]}`
92+
* `{:noreply, state, [push: graph]}`
93+
* in `handle_continue/3`:
94+
* `{:noreply, state, [push: graph]}`
9395

9496
### Breaking Changes
9597

0 commit comments

Comments
 (0)