Skip to content

Commit 7122dd0

Browse files
Use regular quote in source docs of PackageDescription API
1 parent a11b721 commit 7122dd0

File tree

5 files changed

+23
-23
lines changed

5 files changed

+23
-23
lines changed

Sources/PackageDescription4/Package.swift

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ import Foundation
1919

2020
/// The configuration of a Swift package.
2121
///
22-
/// Pass configuration options as parameters to your packages initializer
22+
/// Pass configuration options as parameters to your package's initializer
2323
/// statement to provide the name of the package, its targets, products,
2424
/// dependencies, and other configuration options.
2525
///
@@ -100,8 +100,8 @@ public final class Package {
100100
/// A branch-based requirement
101101
///
102102
/// Select the name of the branch for your package dependency to follow.
103-
/// Use branch-based dependencies when youre developing multiple packages
104-
/// in tandem or when you dont want to publish versions of your package dependencies.
103+
/// Use branch-based dependencies when you're developing multiple packages
104+
/// in tandem or when you don't want to publish versions of your package dependencies.
105105
///
106106
/// Note that packages which use branch-based dependency requirements
107107
/// can't be added as dependencies to packages that use version-based dependency
@@ -111,10 +111,10 @@ public final class Package {
111111
/// A commit-based requirement
112112
///
113113
/// Select the commit hash for your package dependency to follow.
114-
/// Choosing this option isnt recommended, and should be limited to
114+
/// Choosing this option isn't recommended, and should be limited to
115115
/// exceptional cases. While pinning your package dependency to a specific
116-
/// commit ensures that the package dependency doesnt change and your
117-
/// code remains stable, you dont receive any updates at all. If you worry about
116+
/// commit ensures that the package dependency doesn't change and your
117+
/// code remains stable, you don't receive any updates at all. If you worry about
118118
/// the stability of a remote package, consider one of the more
119119
/// restrictive options of the version-based requirement.
120120
///
@@ -388,7 +388,7 @@ extension Package: Encodable {
388388

389389
/// Encodes this package into the given encoder.
390390
///
391-
/// This function throws an error if any values are invalid for the given encoders format.
391+
/// This function throws an error if any values are invalid for the given encoder's format.
392392
///
393393
/// - Parameters:
394394
/// - encoder: The encoder to write data to.
@@ -431,7 +431,7 @@ extension SystemPackageProvider: Encodable {
431431

432432
/// Encodes this system package provider into the given encoder.
433433
///
434-
/// This function throws an error if any values are invalid for the given encoders format.
434+
/// This function throws an error if any values are invalid for the given encoder's format.
435435
///
436436
/// - Parameters:
437437
/// - encoder: The encoder to write data to.
@@ -474,7 +474,7 @@ extension Target.Dependency: Encodable {
474474

475475
/// Encodes this package into the given encoder.
476476
///
477-
/// This function throws an error if any values are invalid for the given encoders format.
477+
/// This function throws an error if any values are invalid for the given encoder's format.
478478
///
479479
/// - Parameters:
480480
/// - encoder: The encoder to write data to.

Sources/PackageDescription4/PackageRequirement.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ extension Package.Dependency.Requirement: Encodable {
117117

118118
/// Encodes this package requirement into the given encoder.
119119
///
120-
/// This function throws an error if any values are invalid for the given encoders format.
120+
/// This function throws an error if any values are invalid for the given encoder's format.
121121
///
122122
/// - Parameters:
123123
/// - encoder: The encoder to write data to.

Sources/PackageDescription4/Product.swift

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ public class Product: Encodable {
8686

8787
/// Encodes this executable product into the given encoder.
8888
///
89-
/// This function throws an error if any values are invalid for the given encoders format.
89+
/// This function throws an error if any values are invalid for the given encoder's format.
9090
///
9191
/// - Parameters:
9292
/// - encoder: The encoder to write data to.
@@ -118,7 +118,7 @@ public class Product: Encodable {
118118
/// The type of the library.
119119
///
120120
/// If the type is unspecified, the Swift Package Manager automatically
121-
/// chooses a type based on the clients preference.
121+
/// chooses a type based on the client's preference.
122122
public let type: LibraryType?
123123

124124
init(name: String, type: LibraryType? = nil, targets: [String]) {
@@ -129,7 +129,7 @@ public class Product: Encodable {
129129

130130
/// Encodes this library product into the given encoder.
131131
///
132-
/// This function throws an error if any values are invalid for the given encoders format.
132+
/// This function throws an error if any values are invalid for the given encoder's format.
133133
///
134134
/// - Parameters:
135135
/// - encoder: The encoder to write data to.
@@ -144,10 +144,10 @@ public class Product: Encodable {
144144
}
145145

146146
/// Create a library product to allow clients that declare a dependency on this package
147-
/// to use the packages functionality.
147+
/// to use the package's functionality.
148148
///
149-
/// A librarys product can either be statically or dynamically linked.
150-
/// If possible, dont declare the type of library explicitly to let
149+
/// A library's product can either be statically or dynamically linked.
150+
/// If possible, don't declare the type of library explicitly to let
151151
/// the Swift Package Manager choose between static or dynamic linking based
152152
/// on the preference of the package's consumer.
153153
///
@@ -179,7 +179,7 @@ public class Product: Encodable {
179179

180180
/// Encodes this product into the given encoder.
181181
///
182-
/// This function throws an error if any values are invalid for the given encoders format.
182+
/// This function throws an error if any values are invalid for the given encoder's format.
183183
///
184184
/// - Parameters:
185185
/// - encoder: The encoder to write data to.

Sources/PackageDescription4/Target.swift

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
/// Each target contains a set of source files that are compiled into a module or test suite.
1414
/// You can vend targets to other packages by defining products that include the targets.
1515
///
16-
/// A target may depend on other targets within the same package and on products vended by the packages dependencies.
16+
/// A target may depend on other targets within the same package and on products vended by the package's dependencies.
1717
public final class Target {
1818

1919
/// The different types of a target.
@@ -23,7 +23,7 @@ public final class Target {
2323
case system
2424
}
2525

26-
/// The different types of a targets dependency on another entity.
26+
/// The different types of a target's dependency on another entity.
2727
public enum Dependency {
2828
#if PACKAGE_DESCRIPTION_4
2929
case targetItem(name: String)
@@ -338,7 +338,7 @@ public final class Target {
338338
///
339339
/// Use system library targets to adapt a library installed on the system to work with Swift packages.
340340
/// Such libraries are generally installed by system package managers (such as Homebrew and apt-get)
341-
/// and exposed to Swift packages by providing a `modulemap` file along with other metadata such as the librarys `pkgConfig` name.
341+
/// and exposed to Swift packages by providing a `modulemap` file along with other metadata such as the library's `pkgConfig` name.
342342
///
343343
/// - Parameters:
344344
/// - name: The name of the target.
@@ -386,7 +386,7 @@ extension Target: Encodable {
386386

387387
/// Encodes this target into the given encoder.
388388
///
389-
/// This function throws an error if any values are invalid for the given encoders format.
389+
/// This function throws an error if any values are invalid for the given encoder's format.
390390
///
391391
/// - Parameters:
392392
/// - encoder: The encoder to write data to.

Sources/PackageDescription4/Version.swift

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
///
2222
/// The first digit of a version, or *major version*, signifies breaking changes to the API that require
2323
/// updates to existing clients. For example, the semantic versioning specification
24-
/// considers renaming an existing type, removing a method, or changing a methods signature
24+
/// considers renaming an existing type, removing a method, or changing a method's signature
2525
/// breaking changes. This also includes any backward-incompatible bug fixes or
2626
/// behavioral changes of the existing API.
2727
///
@@ -138,7 +138,7 @@ extension Version: CustomStringConvertible {
138138
extension Version: Encodable {
139139
/// Encodes this version into the given encoder.
140140
///
141-
/// This function throws an error if any values are invalid for the given encoders format.
141+
/// This function throws an error if any values are invalid for the given encoder's format.
142142
///
143143
/// - Parameters:
144144
/// - encoder: The encoder to write data to.

0 commit comments

Comments
 (0)