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

Fix some DocC warnings. #188

Merged
merged 2 commits into from
Jul 31, 2024
Merged

Fix some DocC warnings. #188

merged 2 commits into from
Jul 31, 2024

Conversation

mbrandonw
Copy link
Member

Just trying to clean up some warnings that have accumulated.

@@ -14,5 +14,4 @@
### Partial case paths

- ``PartialCaseKeyPath``
- ``Swift/PartialKeyPath/callAsFunction(_:)``
Copy link
Member Author

Choose a reason for hiding this comment

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

I don't think this actually exists. Is this old?

Copy link
Member

Choose a reason for hiding this comment

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

Looks like it moved to _AppendKeyPath to properly work. Maybe doesn't need to be documented though.

@@ -227,7 +227,7 @@ public func XCTUnwrap<Enum, Case>(
Actual:
\(String(describing: `enum`))
""",
file: file,
file: (file),
Copy link
Member Author

Choose a reason for hiding this comment

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

I think we want to silence this warning right?

⚠️ Parameter 'file' with default argument '#file' passed to parameter 'file', whose default argument is '#filePath'

Copy link
Member

@stephencelis stephencelis Jul 31, 2024

Choose a reason for hiding this comment

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

I think the way to silence this is to stop using #file since its behavior changes in Swift 6 language mode and instead use #filePath explicitly.

@mbrandonw mbrandonw merged commit 9f36d95 into main Jul 31, 2024
2 checks passed
@mbrandonw mbrandonw deleted the docc-fixes branch July 31, 2024 16:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants