Improve the documentation of Finder::exclude()

mnapoli · web-flow · commit 1f813a57d232 · 2018-03-04T16:13:29.000+01:00
diff --git a/Finder.php b/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`