Skip to content

Commit 1b97e1e

Browse files
minor #26134 Document explicitly that dotfiles and vcs files are ignored by default (mnapoli)
This PR was submitted for the master branch but it was merged into the 2.7 branch instead (closes #26134). Discussion ---------- Document explicitly that dotfiles and vcs files are ignored by default | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | ? | Fixed tickets | None | License | MIT | Doc PR | N/A 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. --- For documentation PRs should I target master or the same branch as bugs? Commits ------- e25b988 Document explicitly that dotfiles and vcs files are ignored by default
2 parents 5b0eac4 + e25b988 commit 1b97e1e

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

Finder.php

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -402,6 +402,8 @@ public function exclude($dirs)
402402
/**
403403
* Excludes "hidden" directories and files (starting with a dot).
404404
*
405+
* This option is enabled by default.
406+
*
405407
* @param bool $ignoreDotFiles Whether to exclude "hidden" files or not
406408
*
407409
* @return $this
@@ -422,6 +424,8 @@ public function ignoreDotFiles($ignoreDotFiles)
422424
/**
423425
* Forces the finder to ignore version control directories.
424426
*
427+
* This option is enabled by default.
428+
*
425429
* @param bool $ignoreVCS Whether to exclude VCS files or not
426430
*
427431
* @return $this

0 commit comments

Comments
 (0)