Add additional explanation and details for compose package #13496
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
319be0b to
48923ab
Compare
gziolo
reviewed
Jan 25, 2019
packages/compose/README.md
Outdated
| @@ -2,6 +2,52 @@ | |||
|
|
|||
| The `compose` package is a collection of handy [Higher Order Components](https://facebook.github.io/react/docs/higher-order-components.html) (HOCs) you can use to wrap your WordPress components and provide some basic features like: state, instance id, pure... | |||
|
|
|||
|
|
|||
| The **compose** function is an alias to flowRight from Lodash. It comes from functional programming world and allows to compose any number of functions. An example that illustrates it for two functions: | |||
There was a problem hiding this comment.
Should it be placed under Usage section?
There was a problem hiding this comment.
I like it at the top since it is explaining what compose is, the top section is using examples to illustrate the definition, where the usage area is for specific use.
gziolo
approved these changes
Jan 25, 2019
|
Great, thanks for the reviews! |
|
@mkaz can you address my comments in a follow-up PR? |
mkaz
added a commit
that referenced
this pull request
Jan 25, 2019
A few minor rewording and updates from @chrisvanpatten in #13496
|
@chrisvanpatten looks like I was too quick for you :-) |
mkaz
added a commit
that referenced
this pull request
Jan 25, 2019
* Update compose documentation A few minor rewording and updates from @chrisvanpatten in #13496 * Update packages/compose/README.md Co-Authored-By: mkaz <marcus@mkaz.com>
This was referenced Feb 4, 2019
youknowriad
pushed a commit
that referenced
this pull request
Mar 6, 2019
* Update compose documentation A few minor rewording and updates from @chrisvanpatten in #13496 * Update packages/compose/README.md Co-Authored-By: mkaz <marcus@mkaz.com>
youknowriad
pushed a commit
that referenced
this pull request
Mar 6, 2019
* Update compose documentation A few minor rewording and updates from @chrisvanpatten in #13496 * Update packages/compose/README.md Co-Authored-By: mkaz <marcus@mkaz.com>
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.
Description
Adds additional information for compose package.
Props to @gziolo for supplying initial write up in ticket.
Fixes #6220
View live on branch here
Types of changes
Documentation.