Skip to content

Documentation improvement #110

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.

Sign up for GitHub

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

Merged
clue merged 1 commit into from
Oct 7, 2019
Merged

Documentation improvement #110

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -447,10 +447,10 @@ if `$promisesOrValues` contains 0 items.
$promise = React\Promise\some(array $promisesOrValues, integer $howMany);
```

Returns a promise that will resolve when `$howMany` of the supplied items in
`$promisesOrValues` resolve. The resolution value of the returned promise
will be an array of length `$howMany` containing the resolution values of the
triggering items.
Returns a promise that will resolve when at least `$howMany` of the supplied items in
Copy link
Member

@jsor jsor Jan 18, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

at least is wrong here. The output promise fulfills after exactly $howManyfulfill and ignores the rest.

Copy link
Contributor Author

@seregazhuk seregazhuk Jan 18, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've replaced word resolve with fulfill.

My intention with word at least was to show, that it is enough for $howMany promises to be fulfilled. For example, when we have 3 pending promises, it is enough for 2 of them to be fulfilled. Not exactly 2 should be fulfilled, and 1 should fail.

`$promisesOrValues` fulfill. The resolution value of the returned promise
will be an array of length `$howMany` containing the resolution values of
`$howMany` fulfilled promises that were resolved first.

The returned promise will reject if it becomes impossible for `$howMany` items
to resolve (that is, when `(count($promisesOrValues) - $howMany) + 1` items
Expand Down