Skip to content

Commit 751ca4e

Browse files
committed
Comment for IgnoreFile class
1 parent c078ad9 commit 751ca4e

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

Sources/SwiftFormat/Core/IgnoreFile.swift

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,12 @@
1212

1313
import Foundation
1414

15+
/// A file that describes which files and directories should be ignored by the formatter.
16+
/// In the future, this file may contain complex rules for ignoring files, based
17+
/// on pattern matching file paths.
18+
///
19+
/// Currently, the only valid content for an ignore file is a single asterisk "*",
20+
/// optionally surrounded by whitespace.
1521
public class IgnoreFile {
1622
/// Name of the ignore file to look for.
1723
/// The presence of this file in a directory will cause the formatter

0 commit comments

Comments
 (0)