Skip to content

Commit e11277f

Browse files
authored
Merge pull request #3182 from SimplyDanny/exclude-md
Exclude documentation from build
2 parents ef367f7 + d07fc82 commit e11277f

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

Package.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -186,7 +186,7 @@ let package = Package(
186186
.target(
187187
name: "SwiftWarningControl",
188188
dependencies: ["SwiftSyntax", "SwiftParser"],
189-
exclude: ["CMakeLists.txt"]
189+
exclude: ["CMakeLists.txt", "SwiftWarningControl.md"]
190190
),
191191

192192
.testTarget(

Sources/SwiftWarningControl/SwiftWarningControl.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ A library to evaluate `@warn` diagnostic group controls within a Swift syntax tr
66

77
Swift provides a mechanism to control the behavior of specific diagnostic groups for a given declaration's lexical scope with the `@warn` attribute.
88

9-
The syntax tree and its parser do not reason about warning group controls. The syntax tree produced by the parser represents the `@warn` attribute in a generic fashion, as it would any other basic attribute on a declaration. The per-declaration nature of the attribute means that for any given lexical scope, the behavior of a given diagnostic group can be queried by checking for the presence of this attribute in its parent declaration scope.
9+
The syntax tree and its parser do not reason about warning group controls. The syntax tree produced by the parser represents the `@warn` attribute in a generic fashion, as it would any other basic attribute on a declaration. The per-declaration nature of the attribute means that for any given lexical scope, the behavior of a given diagnostic group can be queried by checking for the presence of this attribute in its parent declaration scope.
1010

1111
```swift
1212
@warn(Deprecate, as: error)
@@ -23,7 +23,7 @@ func foo() {
2323
}
2424
```
2525

26-
The `SwiftWarningControl` library provides a utility to determine, for a given source location and diagnostic group identifier, whether or not its behavior is affected by an `@warn` attribute of any of its parent declaration scope.
26+
The `SwiftWarningControl` library provides a utility to determine, for a given source location and diagnostic group identifier, whether or not its behavior is affected by an `@warn` attribute of any of its parent declaration scope.
2727

2828
* `SyntaxProtocol.getWarningGroupControl(for diagnosticGroupIdentifier:)` produces the behavior specifier (`WarningGroupBehavior`: `error`, `warning`, `ignored`) which applies at this node.
2929

0 commit comments

Comments
 (0)