Skip to content
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

Merged
merged 1 commit into from
Dec 19, 2018
Merged

Conversation

paldepind
Copy link
Member

The current documentation is pretty outdated with regards to how output works. This is improves the situation somewhat.

README.md Outdated
things simple).

```ts
Component<{}, { value: Behavior<string>, click: Stream<ClickEvent>, ... }
Copy link
Member

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
Copy link
Member

@limemloh limemloh Dec 16, 2018

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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

wether
should be whether.

Copy link
Member

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 😄

Copy link
Member

@limemloh limemloh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor typos

@paldepind
Copy link
Member Author

Thanks @limemloh 😄 I've fixed the typos.

@paldepind paldepind merged commit 167715d into master Dec 19, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants