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

Add additional explanation and details for compose package #13496

Merged
merged 2 commits into from Jan 25, 2019

Conversation

Projects
None yet
4 participants
@mkaz
Copy link
Member

mkaz commented Jan 25, 2019

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.

Add explanation and example for compose package
Uses info from issue #6220 to add additional details and example for
compose package. Props to @gziolo for initial write up in ticket.

Fixes #6220

@mkaz mkaz force-pushed the docs/6220/compose branch from 319be0b to 48923ab Jan 25, 2019

@mkaz mkaz self-assigned this Jan 25, 2019

Show resolved Hide resolved 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:

This comment has been minimized.

@gziolo

gziolo Jan 25, 2019

Member

Should it be placed under Usage section?

This comment has been minimized.

@mkaz

mkaz Jan 25, 2019

Author Member

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.

Show resolved Hide resolved packages/compose/README.md Outdated
Show resolved Hide resolved packages/compose/README.md Outdated
@gziolo

gziolo approved these changes Jan 25, 2019

Copy link
Member

gziolo left a comment

Works for me, the most important part is the content added at the end of the day :)

Thanks for updates 👍

@mkaz

This comment has been minimized.

Copy link
Member Author

mkaz commented Jan 25, 2019

Great, thanks for the reviews!

@mkaz mkaz merged commit 47d6a1d into master Jan 25, 2019

1 check passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details

@youknowriad youknowriad deleted the docs/6220/compose branch Jan 25, 2019

Show resolved Hide resolved packages/compose/README.md
Show resolved Hide resolved packages/compose/README.md
Show resolved Hide resolved packages/compose/README.md
Show resolved Hide resolved packages/compose/README.md
@chrisvanpatten

This comment has been minimized.

Copy link
Member

chrisvanpatten commented Jan 25, 2019

@mkaz can you address my comments in a follow-up PR?

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
@mkaz

This comment has been minimized.

Copy link
Member Author

mkaz commented Jan 25, 2019

@chrisvanpatten looks like I was too quick for you :-)
Created updates in PR #13504

mkaz added a commit that referenced this pull request Jan 25, 2019

Update compose documentation (#13504)
* 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