Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

NFC: 5.9 Documentation update. #6434

Merged
merged 3 commits into from Apr 18, 2023
Merged

Conversation

zkiraly
Copy link
Contributor

@zkiraly zkiraly commented Apr 13, 2023

Review and update the documentation for SwiftPM 5.9

Motivation:

A couple of new API were added to PackageDescription, and these needed new documentation, and in some cases review.

Modifications:

Documentation was added or updated. Nearly all the changes are for post 5.7 API.

Result:

There will be up-to-date documentation in PackageDescription that conforms to the current documentation style.

@zkiraly zkiraly changed the title Documentation update. [5.9] Documentation update. Apr 13, 2023
@zkiraly
Copy link
Contributor Author

zkiraly commented Apr 13, 2023

This is ready for engineering review.

@zkiraly
Copy link
Contributor Author

zkiraly commented Apr 13, 2023

@swift-ci please smoke test.

@@ -47,7 +47,7 @@ public struct Resource {

/// The rule for the resource.
let rule: String

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: trailing whitespace

@@ -12,6 +12,7 @@

/// The build configuration such as debug or release.
public struct BuildConfiguration {
/// The configuration of the build. Valid values are `debug` and `release`.
let config: String
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should not be public, right? Will it still show up in the developer docs?

@tomerd
Copy link
Member

tomerd commented Apr 18, 2023

@swift-ci smoke test

@tomerd tomerd enabled auto-merge (squash) April 18, 2023 20:10
@tomerd tomerd changed the title [5.9] Documentation update. 5.9 Documentation update. Apr 18, 2023
@tomerd tomerd changed the title 5.9 Documentation update. NFC: 5.9 Documentation update. Apr 18, 2023
@tomerd tomerd merged commit 942a1e8 into main Apr 18, 2023
5 checks passed
@tomerd tomerd deleted the zkiraly/5.9-documentation-update branch May 1, 2023 17:51
zkiraly added a commit to zkiraly/swift-package-manager that referenced this pull request May 2, 2023
* Updated documentation for BuildSettings.
* Updated documentation for PackageDescription.
neonichu pushed a commit that referenced this pull request May 3, 2023
* [5.9] Documentation update. (#6434)

* Updated documentation for BuildSettings.
* Updated documentation for PackageDescription.

* [5.9] Editorial review changes of PackageDescription documentation. (#6471)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants