Document explicitly that dotfiles and vcs files are ignored by default

mnapoli · nicolas-grekas · commit 850138b3e3e5 · 2018-02-11T11:02:34.000+01:00
This change makes it clear whether or not each of those two options are enabled by default.

Without this documentation one has to look into the code.
diff --git a/Finder.php b/Finder.php
@@ -402,6 +402,8 @@ public function exclude($dirs)
     /**
      * Excludes "hidden" directories and files (starting with a dot).
      *
+     * This option is enabled by default.
+     *
      * @param bool $ignoreDotFiles Whether to exclude "hidden" files or not
      *
      * @return $this
@@ -422,6 +424,8 @@ public function ignoreDotFiles($ignoreDotFiles)
     /**
      * Forces the finder to ignore version control directories.
      *
+     * This option is enabled by default.
+     *
      * @param bool $ignoreVCS Whether to exclude VCS files or not
      *
      * @return $this

Original file line number	Diff line number	Diff line change
`@@ -402,6 +402,8 @@ public function exclude($dirs)`
`402`	`402`	`/**`
`403`	`403`	`* Excludes "hidden" directories and files (starting with a dot).`
`404`	`404`	`*`
	`405`	`+ * This option is enabled by default.`
	`406`	`+ *`
`405`	`407`	`* @param bool $ignoreDotFiles Whether to exclude "hidden" files or not`
`406`	`408`	`*`
`407`	`409`	`* @return $this`
`@@ -422,6 +424,8 @@ public function ignoreDotFiles($ignoreDotFiles)`
`422`	`424`	`/**`
`423`	`425`	`* Forces the finder to ignore version control directories.`
`424`	`426`	`*`
	`427`	`+ * This option is enabled by default.`
	`428`	`+ *`
`425`	`429`	`* @param bool $ignoreVCS Whether to exclude VCS files or not`
`426`	`430`	`*`
`427`	`431`	`* @return $this`