search

jsonmaur / jumpsuit

MIT License
1.39k stars 74 forks source link

A typo in documentation README #74

Closed gamtiq closed 7 years ago

gamtiq commented 7 years ago

It seems a comma is missed in the following line inside documentation README.md:

Effect('incrementAsync' () => {

adrianmcli commented 7 years ago

It's also missing the import for Effect.

tannerlinsley commented 7 years ago

I'll accept a PR to fix these inconsistencies :) Any takers?

adrianmcli commented 7 years ago

I'll give it a shot.

adrianmcli commented 7 years ago

Btw, it is super unclear that Render() implicitly renders to a div with an id of #app. I only discovered that by going to the API documentation.

This implicit behaviour should either be stated explicitly in the README or removed in favour of explicit declaration of what div to render to.

adrianmcli commented 7 years ago

Well I just got burned again, because the default is #root and not #app. Looks like the API docs are out of date.

adrianmcli commented 7 years ago

Working webpackbin here: http://www.webpackbin.com/V1Q_BpCdf

adrianmcli commented 7 years ago

@tannerlinsley PR submitted! #75

tannerlinsley commented 7 years ago

As for the docs, I could also use some help there if anyone wants to help out on making things more clear. It's just a matter of updating the Readme.md and the markdown files in the documentation directory.