minor #26396 Improve the documentation of Finder::exclude() (mnapoli)

fabpot · fabpot · commit 3379310dd6c3 · 2018-03-04T08:34:45.000-08:00
This PR was merged into the 2.7 branch. Discussion ---------- Improve the documentation of `Finder::exclude()` | Q | A | ------------- | --- | Branch? | 2.7 | Bug fix? | no | New feature? | no  | BC breaks? | no  | Deprecations? | no  | Tests pass? | yes  | Fixed tickets | | License | MIT | Doc PR | Tried to do this and this didn't work: ```php $iterator->in($sourcePath) ->exclude($sourcePath.'/foo'); ``` I read on http://symfony.com/doc/current/components/finder.html that excluded directories need to be relative: ![capture d ecran 2018-03-04 a 16 10 31](https://user-images.githubusercontent.com/720328/36947055-28e47eda-1fc7-11e8-9475-399a3d853169.png) Commits ------- cc3084e Improve the documentation of `Finder::exclude()`
diff --git a/src/Symfony/Component/Finder/Finder.php b/src/Symfony/Component/Finder/Finder.php
@@ -386,6 +386,10 @@ public function size($size)
     /**
      * Excludes directories.
      *
+     * Directories passed as argument must be relative to the ones defined with the `in()` method. For example:
+     *
+     *     $finder->in(__DIR__)->exclude('ruby');
+     *
      * @param string|array $dirs A directory path or an array of directories
      *
      * @return $this

Original file line number	Diff line number	Diff line change
`@@ -386,6 +386,10 @@ public function size($size)`
`386`	`386`	`/**`
`387`	`387`	`* Excludes directories.`
`388`	`388`	`*`
	`389`	+ * Directories passed as argument must be relative to the ones defined with the `in()` method. For example:
	`390`	`+ *`
	`391`	`+ * $finder->in(__DIR__)->exclude('ruby');`
	`392`	`+ *`
`389`	`393`	`* @param string\|array $dirs A directory path or an array of directories`
`390`	`394`	`*`
`391`	`395`	`* @return $this`