Skip to content

Commit ed2dfbb

Browse files
authored
Curate (organize layout) and remove DocC warnings for PackageDescription (#8718)
### Motivation: Cleanup of organization after growth and evolution of the API over the past few years ### Modifications: - added curation to organize methods and properties, pushing deprecated items below - removed extensions no longer needed (and no longer resolved) - resolved warnings for disambiguation reported by DocC - re-organizing package dependencies into groups by URL, registry, or local to break up the large list - added an extension pages for Version and SwiftLanguageMode to provide curation for those symbols ### Result: - deprecated methods moved down, frequently used methods brought up and large lists broken up by usage pattern to make them more accessible.
1 parent 5539bc1 commit ed2dfbb

15 files changed

+83
-82
lines changed

Sources/PackageDescription/PackageDescription.docc/Curation/CLanguageStandard.md

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,3 @@
3737
### Creating a Value
3838

3939
- ``init(rawValue:)``
40-
41-
### Accessing the Raw Value
42-
43-
- ``rawValue-swift.property``
44-
- ``RawValue-swift.typealias``

Sources/PackageDescription/PackageDescription.docc/Curation/CXXLanguageStandard.md

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,3 @@
3333
### Creating a Value
3434

3535
- ``init(rawValue:)``
36-
37-
### Accessing the Raw Value
38-
39-
- ``rawValue-swift.property``
40-
- ``RawValue-swift.typealias``

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

Lines changed: 35 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -2,55 +2,64 @@
22

33
## Topics
44

5-
### Creating a Package Dependency
5+
### Creating a package dependency from a URL
66

7-
- ``package(name:path:)``
8-
- ``package(name:path:traits:)``
9-
- ``package(path:)``
10-
- ``package(path:traits:)``
117
- ``package(url:from:)``
8+
- ``package(url:from:traits:)``
129
- ``package(url:_:)-2ys47``
10+
- ``package(url:_:traits:)-(_,Range<Version>,_)``
1311
- ``package(url:_:)-1r6rc``
12+
- ``package(url:_:traits:)-(_,ClosedRange<Version>,_)``
1413
- ``package(url:branch:)``
14+
- ``package(url:branch:traits:)``
1515
- ``package(url:revision:)``
16+
- ``package(url:revision:traits:)``
1617
- ``package(url:exact:)``
1718
- ``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:)``
19+
20+
### Creating a package dependency from a registry
21+
22+
- ``package(id:from:)``
23+
- ``package(id:from:traits:)``
2324
- ``package(id:_:)-(_,Range<Version>)``
24-
- ``package(id:_:)-(_,ClosedRange<Version>)``
2525
- ``package(id:_:traits:)-(_,Range<Version>,_)``
26+
- ``package(id:_:)-(_,ClosedRange<Version>)``
2627
- ``package(id:_:traits:)-(_,ClosedRange<Version>,_)``
2728
- ``package(id:exact:)``
2829
- ``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``
30+
31+
### Creating a local dependency
32+
33+
- ``package(name:path:)``
34+
- ``package(name:path:traits:)``
35+
- ``package(path:)``
36+
- ``package(path:traits:)``
4037

4138
### Declaring Requirements
4239

43-
- ``requirement-swift.property``
44-
- ``Requirement-swift.enum``
4540
- ``traits``
4641
- ``Trait``
4742
- ``RegistryRequirement``
4843
- ``SourceControlRequirement``
44+
- ``requirement-swift.property``
45+
- ``Requirement-swift.enum``
4946

5047
### Describing a Package Dependency
5148

52-
- ``name``
53-
- ``url``
5449
- ``kind-swift.property``
5550
- ``Kind``
5651
- ``Version``
52+
- ``name``
53+
- ``url``
54+
55+
### Deprecated methods
56+
57+
- ``package(name:url:_:)-(String?,_,_)``
58+
- ``package(name:url:_:)-(_,_,Range<Version>)``
59+
- ``package(name:url:_:)-(_,_,ClosedRange<Version>)``
60+
- ``package(name:url:branch:)``
61+
- ``package(name:url:from:)``
62+
- ``package(name:url:revision:)``
63+
- ``package(url:_:)-(_,Package.Dependency.Requirement)``
64+
- ``name``
65+
- ``url``

Sources/PackageDescription/PackageDescription.docc/Curation/Extensions/LanguageTg-ExtendedGraphemeClusterLiteralType.md

Lines changed: 0 additions & 10 deletions
This file was deleted.

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

Lines changed: 0 additions & 5 deletions
This file was deleted.

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

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,3 @@
1919
### Creating a Value
2020

2121
- <doc:/documentation/PackageDescription/Product/Library/LibraryType/init(rawValue:)>
22-
23-
### Accessing the Raw Value
24-
25-
- ``rawValue-swift.property``
26-
- ``RawValue-swift.typealias``

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

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,3 @@
2222
### Operator Functions
2323

2424
- <doc:/documentation/PackageDescription/LanguageTag/!=(_:_:)>
25-
26-
### Identifying Related Types
27-
28-
- ``LanguageTag/ExtendedGraphemeClusterLiteralType``
29-
- ``LanguageTag/RawValue-swift.typealias``
30-
- ``LanguageTag/StringLiteralType``
31-
- ``LanguageTag/UnicodeScalarLiteralType``

Sources/PackageDescription/PackageDescription.docc/Curation/Package.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -56,11 +56,10 @@
5656
### Declaring Supported Languages
5757

5858
- ``SwiftLanguageMode``
59-
- ``SwiftVersion``
6059
- ``CLanguageStandard``
6160
- ``CXXLanguageStandard``
6261
- ``Package/swiftLanguageModes``
63-
- ``Package/swiftLanguageVersions``
6462
- ``Package/cLanguageStandard``
6563
- ``Package/cxxLanguageStandard``
66-
64+
- ``SwiftVersion``
65+
- ``Package/swiftLanguageVersions``

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

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,3 @@
1919
### Creating a Value
2020

2121
- ``init(rawValue:)``
22-
23-
### Accessing the Raw Value
24-
25-
- ``rawValue-swift.property``
26-
- ``RawValue-swift.typealias``
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# ``PackageDescription/SwiftLanguageMode``
2+
3+
## Topics
4+
5+
### Swift Language Modes
6+
7+
- ``v6``
8+
- ``v5``
9+
- ``v4_2``
10+
- ``v4``
11+
- ``version(_:)``
12+
- ``v3``
13+

0 commit comments

Comments
 (0)