Skip to content

Conversation

@heckj
Copy link
Contributor

@heckj heckj commented Nov 6, 2025

  • update docs ordering to resolve swift-format lint concerns
  • adding deprecation summary to redirect readers to correct API for deprecated versions
  • updating .swift-format to preserve checking going forward

resolves #182

…eprecation summary to redirect readers to correct API for deprecated versions
@heckj heckj self-assigned this Nov 6, 2025
@heckj heckj added the area/documentation Improvements or additions to documentation. label Nov 6, 2025
@heckj heckj requested review from czechboy0 and ktoso November 6, 2025 19:33
@heckj heckj added the semver/none No version bump required. label Nov 6, 2025
@heckj
Copy link
Contributor Author

heckj commented Nov 6, 2025

The last commit in this changes a a number of access levels for properties and types in the Test module. Applying the documentation check applies broadly where-ever the swift-format lint command is triggered, and the current GitHub-workflows script for soundness looks for all .swift files in the repo, and doesn't distinguish between Tests and Sources.

I think that's a reasonable adjustment to support the existing moving parts, but happy to revisit and pull off that last commit if that's not desired.

Package.swift Outdated
dependencies: [
.package(url: "https://github.com/apple/swift-service-context.git", from: "1.1.0")
.package(url: "https://github.com/apple/swift-service-context.git", from: "1.1.0"),
.package(url: "https://github.com/swiftlang/swift-docc-plugin", from: "1.0.0"),
Copy link
Contributor

Choose a reason for hiding this comment

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

Please remove the docc plugin again, we generally just let CI scripts add it temporarily, but don't have it in other packages like Swift Log.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

🤦 darnit - sorry, I know better

@heckj heckj requested a review from czechboy0 November 7, 2025 16:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/documentation Improvements or additions to documentation. semver/none No version bump required.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Ensure all public APIs have docs

2 participants