Skip to content

Commit 83214f0

Browse files
authored
Fix parameter documentation in PackageDependency.swift (#7682)
* Remove mention of `nil` name which is not allowed due to the parameters being non-optional. * Synchronize wording describing local package paths.
1 parent e173143 commit 83214f0

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

Sources/PackageDescription/PackageDependency.swift

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -241,8 +241,8 @@ extension Package.Dependency {
241241
/// packages.
242242
///
243243
/// - Parameters:
244-
/// - name: The name of the Swift package or `nil` to deduce the name from path.
245-
/// - path: The local path to the package.
244+
/// - name: The name of the Swift package.
245+
/// - path: The file system path to the package.
246246
///
247247
/// - Returns: A package dependency.
248248
@available(_PackageDescription, introduced: 5.2)
@@ -261,8 +261,8 @@ extension Package.Dependency {
261261
/// packages.
262262
///
263263
/// - Parameters:
264-
/// - name: The name of the Swift package or `nil` to deduce the name from path.
265-
/// - path: The local path to the package.
264+
/// - name: The name of the Swift package.
265+
/// - path: The file system path to the package.
266266
/// - traits: The trait configuration of this dependency. Defaults to enabling the default traits.
267267
///
268268
/// - Returns: A package dependency.

0 commit comments

Comments
 (0)