Skip to content

Commit 68d55b1

Browse files
committed
Fix a number of minor curated documentation issues
Fixing wrong parameter names, adding missing APIs to the curation, removing a couple non-existent things.
1 parent f161b02 commit 68d55b1

21 files changed

+90
-49
lines changed

Sources/PackageDescription/PackageDependency.swift

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -511,7 +511,6 @@ extension Package.Dependency {
511511
/// ```
512512
///
513513
/// - Parameters:
514-
/// - name: The name of the package, or nil to deduce it from the URL.
515514
/// - url: The valid Git URL of the package.
516515
/// - range: The custom version range requirement.
517516
///
@@ -534,7 +533,6 @@ extension Package.Dependency {
534533
/// ```
535534
///
536535
/// - Parameters:
537-
/// - name: The name of the package, or nil to deduce it from the URL.
538536
/// - url: The valid Git URL of the package.
539537
/// - range: The custom version range requirement.
540538
/// - traits: The trait configuration of this dependency. Defaults to enabling the default traits.
@@ -585,7 +583,6 @@ extension Package.Dependency {
585583
/// ```
586584
///
587585
/// - Parameters:
588-
/// - name: The name of the package, or `nil` to deduce it from the URL.
589586
/// - url: The valid Git URL of the package.
590587
/// - range: The closed version range requirement.
591588
///
@@ -608,7 +605,6 @@ extension Package.Dependency {
608605
/// ```
609606
///
610607
/// - Parameters:
611-
/// - name: The name of the package, or `nil` to deduce it from the URL.
612608
/// - url: The valid Git URL of the package.
613609
/// - range: The closed version range requirement.
614610
/// - traits: The trait configuration of this dependency. Defaults to enabling the default traits.
@@ -788,7 +784,6 @@ extension Package.Dependency {
788784
/// Adds a remote package dependency given a version requirement.
789785
///
790786
/// - Parameters:
791-
/// - name: The name of the package, or nil to deduce it from the URL.
792787
/// - url: The valid Git URL of the package.
793788
/// - requirement: A dependency requirement. See static methods on `Package.Dependency.Requirement` for available options.
794789
///

Sources/PackageDescription/PackageDescription.docc/Curation/BuildSettingCondition.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,6 @@
66

77
- ``when(platforms:)``
88
- ``when(configuration:)``
9-
- ``when(platforms:configuration:)-2991l``
109
- ``when(platforms:configuration:)-475co``
10+
- ``when(platforms:configuration:traits:)``
11+
- ``when(platforms:configuration:)-2991l``

Sources/PackageDescription/PackageDescription.docc/Curation/Dependency.md

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,20 +5,52 @@
55
### Creating a Package Dependency
66

77
- ``package(name:path:)``
8+
- ``package(name:path:traits:)``
9+
- ``package(path:)``
10+
- ``package(path:traits:)``
811
- ``package(url:from:)``
912
- ``package(url:_:)-2ys47``
1013
- ``package(url:_:)-1r6rc``
1114
- ``package(url:branch:)``
1215
- ``package(url:revision:)``
1316
- ``package(url:exact:)``
14-
- ``package(path:)``
17+
- ``package(url:exact:traits:)``
18+
- ``package(url:_:traits:)-(_,Range<Version>,_)``
19+
- ``package(url:_:traits:)-(_,ClosedRange<Version>,_)``
20+
- ``package(url:branch:traits:)``
21+
- ``package(url:from:traits:)``
22+
- ``package(url:revision:traits:)``
23+
- ``package(id:_:)-(_,Range<Version>)``
24+
- ``package(id:_:)-(_,ClosedRange<Version>)``
25+
- ``package(id:_:traits:)-(_,Range<Version>,_)``
26+
- ``package(id:_:traits:)-(_,ClosedRange<Version>,_)``
27+
- ``package(id:exact:)``
28+
- ``package(id:exact:traits:)``
29+
- ``package(id:from:)``
30+
- ``package(id:from:traits:)``
31+
- ``package(name:url:_:)-(String?,_,_)``
32+
- ``package(name:url:_:)-(_,_,Range<Version>)``
33+
- ``package(name:url:_:)-(_,_,ClosedRange<Version>)``
34+
- ``package(name:url:branch:)``
35+
- ``package(name:url:from:)``
36+
- ``package(name:url:revision:)``
37+
- ``package(url:_:)-(_,Package.Dependency.Requirement)``
38+
- ``name``
39+
- ``url``
1540

1641
### Declaring Requirements
1742

1843
- ``requirement-swift.property``
1944
- ``Requirement-swift.enum``
45+
- ``traits``
46+
- ``Trait``
47+
- ``RegistryRequirement``
48+
- ``SourceControlRequirement``
2049

2150
### Describing a Package Dependency
2251

52+
- ``name``
53+
- ``url``
2354
- ``kind-swift.property``
55+
- ``Kind``
2456
- ``Version``

Sources/PackageDescription/PackageDescription.docc/Curation/Extensions/CLanguageStandard-hash.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@
66

77
Hashes the C language standard by feeding the item into the given hasher.
88

9-
- Parameter into: The hasher.
9+
- Parameter hasher: The hasher.

Sources/PackageDescription/PackageDescription.docc/Curation/Extensions/CXXLanguageStandard-hash.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@
66

77
Hashes the C++ language standard by feeding the item into the given hasher.
88

9-
- Parameter into: The hasher.
9+
- Parameter hasher: The hasher.

Sources/PackageDescription/PackageDescription.docc/Curation/Extensions/LanguageTag-hash.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@
66

77
Hashes the language tag by feeding the item into the given hasher.
88

9-
- Parameter into: The hasher.
9+
- Parameter hasher: The hasher.

Sources/PackageDescription/PackageDescription.docc/Curation/Extensions/Library-LibraryType-hash.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,4 +11,4 @@ Implement this method to conform to the Hashable protocol. The components used f
1111
> Important:
1212
> Never call finalize() on hasher. Doing so may become a compile-time error in the future.
1313
14-
- Parameter into: The hasher to use when combining the components of this instance.
14+
- Parameter hasher: The hasher to use when combining the components of this instance.

Sources/PackageDescription/PackageDescription.docc/Curation/Extensions/Resource-Localization-hash.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@
66

77
Hashes the localization by feeding the item into the given hasher.
88

9-
- Parameter into: The hasher.
9+
- Parameter hasher: The hasher.

Sources/PackageDescription/PackageDescription.docc/Curation/Extensions/Target-TargetType-hash.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,6 @@
66

77
Hashes the target type by feeding the item into the given hasher.
88

9-
- Parameter into: The hasher.
9+
- Parameter hasher: The hasher.
1010

1111

Sources/PackageDescription/PackageDescription.docc/Curation/LanguageTag.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@
44

55
### Creating a Language Tag
66

7-
- ``init(_:)``
87
- <doc:/documentation/PackageDescription/LanguageTag/init(extendedGraphemeClusterLiteral:)-36buv>
98
- ``init(stringLiteral:)``
109
- <doc:/documentation/PackageDescription/LanguageTag/init(unicodeScalarLiteral:)-1j41k>
@@ -13,7 +12,6 @@
1312

1413
### Describing a Language Tag
1514

16-
- ``tag``
1715
- ``description``
1816

1917
### Hashing

0 commit comments

Comments
 (0)