Traits docs #9048
Merged
Traits docs #9048
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@swift-ci please test |
…ation of traits and wording updates across the API surface
… article to reference traits for using them
heckj
requested review from
jakepetroules,
dschaefer2,
shawnhyam,
bripeticca,
plemarquand,
owenv,
bkhouri,
cmcgee1024 and
daveyc123
as code owners
|
@swift-ci please test |
bripeticca
requested changes
Aug 27, 2025
Sources/PackageManagerDocs/Documentation.docc/AddingDependencies.md
Outdated
Show resolved
Hide resolved
Sources/PackageManagerDocs/Documentation.docc/AddingDependencies.md
Outdated
Show resolved
Hide resolved
Sources/PackageManagerDocs/Documentation.docc/AddingDependencies.md
Outdated
Show resolved
Hide resolved
Sources/PackageManagerDocs/Documentation.docc/Dependencies/PackageTraits.md
Outdated
Show resolved
Hide resolved
Sources/PackageManagerDocs/Documentation.docc/AddingDependencies.md
Outdated
Show resolved
Hide resolved
FranzBusch
reviewed
Aug 28, 2025
Sources/PackageManagerDocs/Documentation.docc/AddingDependencies.md
Outdated
Show resolved
Hide resolved
Sources/PackageManagerDocs/Documentation.docc/Dependencies/PackageTraits.md
Outdated
Show resolved
Hide resolved
Sources/PackageManagerDocs/Documentation.docc/Dependencies/PackageTraits.md
Outdated
Show resolved
Hide resolved
| Within the package, traits express conditional compilation, and may be used to declare additional dependencies that are enabled when that trait is active. | ||
|
|
||
| Traits are identified by their names, which are name-spaced within the package that hosts them. |
There was a problem hiding this comment.
IIRC the latest is that traits use be valid Swift identifiers. We can link to the Swift book's grammar section on this.
There was a problem hiding this comment.
According to the SE docs, it's the identifiers with the addition of + and -, but I'll simplify this up. The SE proposal and internal docs were quite specific, so I reflected that here. Please take a look at the revised content and verify that it's accurate
Sources/PackageManagerDocs/Documentation.docc/Dependencies/PackageTraits.md
Outdated
Show resolved
Hide resolved
Sources/PackageManagerDocs/Documentation.docc/Dependencies/PackageTraits.md
Show resolved
Hide resolved
|
@swift-ci test windows |
Co-authored-by: Franz Busch <privat@franz-busch.de>
Co-authored-by: Bri Peticca <bripeticca@gmail.com>
Co-authored-by: Bri Peticca <bripeticca@gmail.com>
Co-authored-by: Bri Peticca <bripeticca@gmail.com>
Co-authored-by: Bri Peticca <bripeticca@gmail.com>
bripeticca
approved these changes
Aug 29, 2025
|
@swift-ci please test |
|
@swift-ci please test windows |
|
@swift-ci please test macOS |
|
@swift-ci please test linux |
1 similar comment
|
@swift-ci please test linux |
johnbute
pushed a commit
to johnbute/fork-swift-package-manager
that referenced
this pull request
Oct 2, 2025
Adds documentation for the Swift 6.1 traits feature ### Motivation: - Show how to consume packages that provide traits - Show how to present traits from your package(s) - Updating PackageDescription API to use slightly more readable content related to traits. ### Modifications: - updated PackageDescription API around traits - added curation (organization) for Traits and Package/Dependency/Traits - extended `Using Dependencies` article to touch on traits and how to consume packages that provide them - added an article to share patterns to use when providing a traits from your own package ### Result: Updated content and one additional article in the central documentation for Swift Package Manager that illustrates how to consume and provide packages with traits. --------- Co-authored-by: Franz Busch <privat@franz-busch.de> Co-authored-by: Bri Peticca <bripeticca@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds documentation for the Swift 6.1 traits feature
Motivation:
Modifications:
Using Dependenciesarticle to touch on traits and how to consume packages that provide themResult:
Updated content and one additional article in the central documentation for Swift Package Manager that illustrates how to consume and provide packages with traits.