Skip to content

Commit

Permalink
Comment for IgnoreFile class
Browse files Browse the repository at this point in the history
  • Loading branch information
samdeane committed Nov 27, 2024
1 parent c078ad9 commit 751ca4e
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions Sources/SwiftFormat/Core/IgnoreFile.swift
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,12 @@

import Foundation

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

0 comments on commit 751ca4e

Please sign in to comment.