Skip to content

Commit 6aabf67

Browse files
authored
improve the availablity message for deprecated manifest APIs (#3833)
motivation: existing message is generic and does not provide an actionable guidance changes: add information to the message to make it more actionable
1 parent c22c9e9 commit 6aabf67

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

Sources/PackageDescription/PackageDependency.swift

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -411,7 +411,7 @@ extension Package.Dependency {
411411
/// - name: The name of the package, or nil to deduce it from the URL.
412412
/// - url: The valid Git URL of the package.
413413
/// - requirement: A dependency requirement. See static methods on `Package.Dependency.Requirement` for available options.
414-
@available(_PackageDescription, deprecated: 5.6, message: "use specific requirement APIs instead")
414+
@available(_PackageDescription, deprecated: 5.6, message: "use specific requirement APIs instead (e.g. use 'branch:' instead of '.branch')")
415415
public static func package(
416416
url: String,
417417
_ requirement: Package.Dependency.Requirement
@@ -425,7 +425,7 @@ extension Package.Dependency {
425425
/// - name: The name of the package, or `nil` to deduce it from the URL.
426426
/// - url: The valid Git URL of the package.
427427
/// - requirement: A dependency requirement. See static methods on `Package.Dependency.Requirement` for available options.
428-
@available(_PackageDescription, introduced: 5.2, deprecated: 5.6, message: "use specific requirement APIs instead")
428+
@available(_PackageDescription, introduced: 5.2, deprecated: 5.6, message: "use specific requirement APIs instead (e.g. use 'branch:' instead of '.branch')")
429429
public static func package(
430430
name: String?,
431431
url: String,

0 commit comments

Comments
 (0)