A more detailed intro in the README. #148
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mdiep
requested changes
Dec 9, 2016
README.md
Outdated
| ### Core Reactive Primitives | ||
| | Primitive | Description | | ||
| | --------- | ------------| | ||
| | `Signal` | `Signal` is a unilateral stream of events.<br /><br />It is like a live TV feed - you can observe and react to the content, but you cannot have a side effect on the live feed. | |
Contributor
There was a problem hiding this comment.
I don't think unilateral is the right word here. Unidirectional, maybe?
The - should should be replaced by — here and below.
sharplet
reviewed
Dec 12, 2016
README.md
Outdated
| * Control actions and responder chain events | ||
| * [Futures and promises](https://en.wikipedia.org/wiki/Futures_and_promises) | ||
| * [Key-value observing](https://developer.apple.com/library/mac/documentation/Cocoa/Conceptual/KeyValueObserving/KeyValueObserving.html) (KVO) | ||
| These primitives can be used to uniformly represent common Cocoa and generic programming patterns that are fundamentally an act of observation, e.g. delegate pattern, callback closures, notifications, control actions, responder chain events, [futures, promises](https://en.wikipedia.org/wiki/Futures_and_promises) and [key-value observing](https://developer.apple.com/library/mac/documentation/Cocoa/Conceptual/KeyValueObserving/KeyValueObserving.html) (KVO). |
Contributor
There was a problem hiding this comment.
I think "futures/promises" would read better than "futures, promises"
mdiep
requested changes
Dec 13, 2016
README.md
Outdated
| It is like a frame in a one-time live feed — seas of data frames carry the visual and audio data, but the feed would eventually be terminated with a special frame to indicate "end of stream". | ||
|
|
||
| #### `SignalProducer`: deferred work that creates a stream of value. | ||
| `SignalProducer` defers work — of which the output is represented as a stream of value — until it is started. For every invocation to start the `SignalProducer`, a new `Signal` is created and the deferred work is subsequently invoked. |
README.md
Outdated
|
|
||
| ```swift | ||
| let channel: Signal<Programme, NoError> = tvStation.channelOne | ||
| channel.observeValues { programme in ... } |
Contributor
There was a problem hiding this comment.
RAC uses US English, so this should be program.
mdiep
reviewed
Dec 13, 2016
README.md
Outdated
|
|
||
| #### `SignalProducer`: deferred work that creates a stream of value. | ||
| #### `SignalProducer`: deferred work that creates a stream of values. | ||
| `SignalProducer` defers work — of which the output is represented as a stream of value — until it is started. For every invocation to start the `SignalProducer`, a new `Signal` is created and the deferred work is subsequently invoked. |
Contributor
There was a problem hiding this comment.
stream of value is repeated in the body text too. 🙈
mdiep
approved these changes
Dec 14, 2016
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
It adds a table of "core reactive primitives" with a very brief description plus a metaphor.