Part 2 of the PackageDescription DocC documentation update #4277
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
added 6 commits
April 8, 2022 08:58
Catching up to main.
Catching up to main.
zkiraly
requested review from
abertelrud,
neonichu,
tomerd and
elsh
as code owners
|
@swift-ci please smoke test. |
neonichu
approved these changes
Apr 21, 2022
| @@ -182,7 +181,7 @@ public struct CXXSetting: Encodable { | |||
| private init(name: String, value: [String], condition: BuildSettingCondition?) { | |||
| self.data = BuildSettingData(name: name, value: value, condition: condition) | |||
| } | |||
|
|
|||
There was a problem hiding this comment.
whitespace-only line
| public static func linkedLibrary(_ library: String, _ condition: BuildSettingCondition? = nil) -> LinkerSetting { | ||
| return LinkerSetting(name: "linkedLibrary", value: [library], condition: condition) | ||
| } | ||
|
|
||
There was a problem hiding this comment.
whitespace-only line
| @@ -51,39 +58,40 @@ public struct Resource: Encodable { | |||
| self.path = path | |||
| self.localization = localization | |||
| } | |||
|
|
|||
| /// Applies a platform-specific rule to the resource at the given path. | |||
|
|
|||
There was a problem hiding this comment.
whitespace-only line
|
|
||
| /// Applies a platform-specific rule to the resource at the given path. | ||
| /// Apply platform-specific rules to the resource at the given path. |
There was a problem hiding this comment.
I think the convention is using 3rd-person present tense, so "Applies" instead of "Apply"
|
@swift-ci please smoke test. |
abertelrud
reviewed
Apr 22, 2022
| @@ -127,10 +130,8 @@ public struct CSetting: Encodable { | |||
| /// | |||
| /// The path must be a directory inside the package. | |||
| /// | |||
| /// - Since: First available in PackageDescription 5.0 | |||
There was a problem hiding this comment.
Should this and the other "Since"s really get removed? In the corresponding PR 1, it seemed that they were getting preserved since they convey useful information.
There was a problem hiding this comment.
Added all of them back in.
|
@swift-ci please smoke test. |
|
@swift-ci please smoke test. |
zkiraly
added a commit
to zkiraly/swift-package-manager
that referenced
this pull request
Apr 23, 2022
…#4277) * Part 2 of the documentation update. * Adopted some of the comments from the companion PR swiftlang#4276. * A few minor edits to the DocC documentation comments. * More minor edits. * Another minor edit. * Removed some unwanted blank-space. * Changed "apply" to 3rd person present tense. * Removed blank-space. * Fixed a typo/ * Added back the Since docs that were deleted. Co-authored-by: Zsolt Kiraly <[email protected]>
tomerd
pushed a commit
that referenced
this pull request
Apr 23, 2022
* Part 2 of the documentation update. * Adopted some of the comments from the companion PR #4276. * A few minor edits to the DocC documentation comments. * More minor edits. * Another minor edit. * Removed some unwanted blank-space. * Changed "apply" to 3rd person present tense. * Removed blank-space. * Fixed a typo/ * Added back the Since docs that were deleted. Co-authored-by: Zsolt Kiraly <[email protected]>
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.
Part 2: Update DocC documentation in the PackageDescription library. Only
Target,Product, and symbols curated under those two are in the PR.Motivation:
The DocC documentation in PackageDescription was not complete, and was out of sync with (and in some cases ahead of) Apple's documentation at developer.apple.com.
Modifications:
Many DocC documentation comments were added or changed inside Sources/PackageDescription.
Result:
There was no code change. Only source code comments were changed in Sources/PackageDescription, and DocC extension files were added in the documentation catalog in that directory.