Skip to content

Commit dba874b

Browse files
committed
Fix documentation
1 parent f384f62 commit dba874b

File tree

2 files changed

+5
-4
lines changed

2 files changed

+5
-4
lines changed

Sources/SwiftFormat/API/SwiftFormatter.swift

+2-2
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ public final class SwiftFormatter {
4545
/// This form of the `format` function automatically folds expressions using the default operator
4646
/// set defined in Swift. If you need more control over this—for example, to provide the correct
4747
/// precedence relationships for custom operators—you must parse and fold the syntax tree
48-
/// manually and then call ``format(syntax:assumingFileURL:to:)``.
48+
/// manually and then call ``format(syntax:source:operatorTable:assumingFileURL:selection:to:)``.
4949
///
5050
/// - Parameters:
5151
/// - url: The URL of the file containing the code to format.
@@ -81,7 +81,7 @@ public final class SwiftFormatter {
8181
/// This form of the `format` function automatically folds expressions using the default operator
8282
/// set defined in Swift. If you need more control over this—for example, to provide the correct
8383
/// precedence relationships for custom operators—you must parse and fold the syntax tree
84-
/// manually and then call ``format(syntax:assumingFileURL:to:)``.
84+
/// manually and then call ``format(syntax:source:operatorTable:assumingFileURL:selection:to:)``.
8585
///
8686
/// - Parameters:
8787
/// - source: The Swift source code to be formatted.

Sources/SwiftFormat/API/SwiftLinter.swift

+3-2
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ public final class SwiftLinter {
4545
/// This form of the `lint` function automatically folds expressions using the default operator
4646
/// set defined in Swift. If you need more control over this—for example, to provide the correct
4747
/// precedence relationships for custom operators—you must parse and fold the syntax tree
48-
/// manually and then call ``lint(syntax:assumingFileURL:)``.
48+
/// manually and then call ``lint(syntax:source:operatorTable:assumingFileURL:)``.
4949
///
5050
/// - Parameters:
5151
/// - url: The URL of the file containing the code to format.
@@ -76,7 +76,7 @@ public final class SwiftLinter {
7676
/// This form of the `lint` function automatically folds expressions using the default operator
7777
/// set defined in Swift. If you need more control over this—for example, to provide the correct
7878
/// precedence relationships for custom operators—you must parse and fold the syntax tree
79-
/// manually and then call ``lint(syntax:assumingFileURL:)``.
79+
/// manually and then call ``lint(syntax:source:operatorTable:assumingFileURL:)``.
8080
///
8181
/// - Parameters:
8282
/// - source: The Swift source code to be linted.
@@ -124,6 +124,7 @@ public final class SwiftLinter {
124124
///
125125
/// - Parameters:
126126
/// - syntax: The Swift syntax tree to be converted to be linted.
127+
/// - source: The Swift source code to be linted.
127128
/// - operatorTable: The table that defines the operators and their precedence relationships.
128129
/// This must be the same operator table that was used to fold the expressions in the `syntax`
129130
/// argument.

0 commit comments

Comments
 (0)