Skip to content
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

make README more consise #809

Merged
merged 2 commits into from
Jun 29, 2015
Merged

make README more consise #809

merged 2 commits into from
Jun 29, 2015

Conversation

charlierudolph
Copy link
Contributor

@aearly

  • remove unneeded documentation about series/limit
    • every command reexplains what it does
  • shorten the list of commands by grouping those very similar
    • makes it easier to scan the list and see all the functionality the library provides

@aearly
Copy link
Collaborator

aearly commented Jun 28, 2015

👍 for this, especially because I want to add limit and series variations for more methods.

I also now realize that there's nowhere where it actually explains what the difference is between the fooLimit and fooSeries variants. I think we need a section explaining that many methods are parallel by default, and then with limit and series versions.

@aearly aearly added the docs label Jun 28, 2015
@charlierudolph
Copy link
Contributor Author

I added the little blurb about Limit and Series above the list of functions. Is that enough or what else are you looking for?

@aearly
Copy link
Collaborator

aearly commented Jun 29, 2015

Cool, that works.

aearly added a commit that referenced this pull request Jun 29, 2015
@aearly aearly merged commit 4e402ad into caolan:master Jun 29, 2015
@charlierudolph charlierudolph deleted the cr-shortenReadme branch July 3, 2015 00:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants