purescript-contrib / purescript-react

React Bindings for PureScript
MIT License
399 stars 65 forks source link

Better Documentation, subtle typos and syntactic details #165

Closed athanclark closed 5 years ago

athanclark commented 5 years ago

There is some additional prose I wrote in README that should probably be reviewed to ensure it explains the concept correctly. I've also added an additional detail to the createLeafNode inline documentation.

There are a couple of semicolons I've added to the React.js foreign interface, but nothing invasive.

I've also exposed the fragment ReactClass in React.purs, for people who don't necessarily want a keyed fragment.

There were also a few typos in other parts of the inline documentation, with the troublesome double-tick ``.

natefaubion commented 5 years ago

Note that fragments are available through the toElement instance for Array ReactElement.

ethul commented 5 years ago

Thanks for these updates. Looks great!

One comment about the clock example. Would it make sense to update the example, and then reference it later, instead of providing it again in the Understanding Children section? Or is your preference to have both for contrast?

athanclark commented 5 years ago

I think it would be best to have them both contrast, so people are introduced to the general concept of createElement, before moving on to the more specific use case.

ethul commented 5 years ago

Sounds good. Thanks again