Better Documentation, subtle typos and syntactic details #165
Conversation
This file contains 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
|
Note that fragments are available through the |
natefaubion
reviewed
Feb 18, 2019
src/React.purs
Outdated
| -- | Create an element from a React class that does not require children. | ||
| -- | Create an element from a React class that does not require children. Additionally it can be used | ||
| -- | when the children are represented /only/ through the `children` prop - for instance, a `ContextConsumer` | ||
| -- | would be turned into a `ReactElement` with `createLeafElement someContext.consumer { children = \x -> ... }`. |
There was a problem hiding this comment.
This should be :, not =.
|
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 |
|
I think it would be best to have them both contrast, so people are introduced to the general concept of |
|
Sounds good. Thanks again |
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.
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
createLeafNodeinline documentation.There are a couple of semicolons I've added to the
React.jsforeign interface, but nothing invasive.I've also exposed the
fragmentReactClass inReact.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
``.