-
Notifications
You must be signed in to change notification settings - Fork 27
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update output documentation #99
Conversation
README.md
Outdated
things simple). | ||
|
||
```ts | ||
Component<{}, { value: Behavior<string>, click: Stream<ClickEvent>, ... } |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
missing closing >
README.md
Outdated
event listeners in other frameworks. However, there are fundamental | ||
differences between the two things. If you are familiar with how | ||
asynchronous functions that takes callbacks differ from asynchronous | ||
function that returns promises then the following analogy make help |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
the following analogy make help
I assume you mean to write:
the following analogy may help
README.md
Outdated
* A button outputs, among other things, a stream of click events. So | ||
part of its output is a stream of the type `Stream<ClickEvent>>`. | ||
* An input box's output includes a behavior of the text inside the | ||
input. The type would be `Behavior<string>`. | ||
* A checkbox might output a behavior representing wether it is checked |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
wether
should be whether.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I guess that is actually an old typo, but should still be fixed 😄
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Minor typos
3d340e5
to
0bc6f88
Compare
Thanks @limemloh 😄 I've fixed the typos. |
The current documentation is pretty outdated with regards to how output works. This is improves the situation somewhat.