minor #29606 [Form] Fixed FormErrorIterator class phpdoc (vudaltsov)

nicolas-grekas · nicolas-grekas · commit 488617394afd · 2018-12-14T13:15:53.000+01:00
This PR was squashed before being merged into the 3.4 branch (closes #29606). Discussion ---------- [Form] Fixed FormErrorIterator class phpdoc | Q | A | ------------- | --- | Branch? | 3.4 | Bug fix? | yes | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | n/a | License | MIT | Doc PR | n/a Fixed an outdated paragraph in `FormErrorIterator` (since #10418). Commits ------- 732b863 [Form] Fixed FormErrorIterator class phpdoc
diff --git a/src/Symfony/Component/Form/FormErrorIterator.php b/src/Symfony/Component/Form/FormErrorIterator.php
@@ -19,10 +19,9 @@
 /**
  * Iterates over the errors of a form.
  *
- * Optionally, this class supports recursive iteration. In order to iterate
- * recursively, set the constructor argument $deep to true. Now each element
- * returned by the iterator is either an instance of {@link FormError} or of
- * {@link FormErrorIterator}, in case the errors belong to a sub-form.
+ * This class supports recursive iteration. In order to iterate recursively,
+ * pass a structure of {@link FormError} and {@link FormErrorIterator} objects
+ * to the $errors constructor argument.
  *
  * You can also wrap the iterator into a {@link \RecursiveIteratorIterator} to
  * flatten the recursive structure into a flat list of errors.

Original file line number	Diff line number	Diff line change
`@@ -19,10 +19,9 @@`
`19`	`19`	`/**`
`20`	`20`	`* Iterates over the errors of a form.`
`21`	`21`	`*`
`22`		`- * Optionally, this class supports recursive iteration. In order to iterate`
`23`		`- * recursively, set the constructor argument $deep to true. Now each element`
`24`		`- * returned by the iterator is either an instance of {@link FormError} or of`
`25`		`- * {@link FormErrorIterator}, in case the errors belong to a sub-form.`
	`22`	`+ * This class supports recursive iteration. In order to iterate recursively,`
	`23`	`+ * pass a structure of {@link FormError} and {@link FormErrorIterator} objects`
	`24`	`+ * to the $errors constructor argument.`
`26`	`25`	`*`
`27`	`26`	`* You can also wrap the iterator into a {@link \RecursiveIteratorIterator} to`
`28`	`27`	`* flatten the recursive structure into a flat list of errors.`