Skip to content

Commit

Permalink
correct PhpDoc for Collection stopWhen()
Browse files Browse the repository at this point in the history
  • Loading branch information
adamharley committed Jan 8, 2019
1 parent 1afba2a commit 1f92799
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions src/Collection/CollectionInterface.php
Expand Up @@ -868,7 +868,7 @@ public function listNested($dir = 'desc', $nestingKey = 'children');

/**
* Creates a new collection that when iterated will stop yielding results if
* the provided condition evaluates to false.
* the provided condition evaluates to true.
*
* This is handy for dealing with infinite iterators or any generator that
* could start returning invalid elements at a certain point. For example,
Expand All @@ -893,7 +893,7 @@ public function listNested($dir = 'desc', $nestingKey = 'children');
* ```
*
* @param callable $condition the method that will receive each of the elements and
* returns false when the iteration should be stopped.
* returns true when the iteration should be stopped.
* If an array, it will be interpreted as a key-value list of conditions where
* the key is a property path as accepted by `Collection::extract`,
* and the value the condition against with each element will be matched.
Expand Down

0 comments on commit 1f92799

Please sign in to comment.