Browse Source

More doc block clarifications.

Mark Story 10 years ago
parent
commit
01211a684e

+ 3 - 2
src/Collection/Iterator/NoChildrenIterator.php

@@ -18,8 +18,9 @@ use Cake\Collection\Collection;
 use RecursiveIterator;
 
 /**
- * An iterator that can be used as argument for other iterators that require
- * a RecursiveIterator, but that will always report as having no nested items.
+ * An iterator that can be used as an argument for other iterators that require
+ * a RecursiveIterator but do not want children. This iterator will 
+ * always behave as having no nested items.
  */
 class NoChildrenIterator extends Collection implements RecursiveIterator
 {

+ 3 - 3
src/Collection/Iterator/UnfoldIterator.php

@@ -28,8 +28,8 @@ class UnfoldIterator extends IteratorIterator implements RecursiveIterator
 {
 
     /**
-     * A functions that gets passed each of the elements of this iterator and
-     * that must return an array or Traversable object.
+     * A function that is passed each element in this iterator and
+     * must return an array or Traversable object.
      *
      * @var callable
      */
@@ -70,7 +70,7 @@ class UnfoldIterator extends IteratorIterator implements RecursiveIterator
     }
 
     /**
-     * Returns an iterator containing the items generated out of transforming
+     * Returns an iterator containing the items generated by transforming
      * the current value with the callable function.
      *
      * @return \RecursiveIterator