Mark #expect(_:throws:) and #require(_:throws:) as to-be-deprecated.#875
Merged
Merged
Conversation
These symbols should go through a transition period where they are documented as to-be-deprecated rather than being deprecated outright. My mistake. With this change applied, Xcode treats these macros as deprecated (deemphasizing them in autocomplete, for instance) and DocC marks them as deprecated in an unspecified Swift version, but no warning is emitted if they are used. This is consistent with API marked `API_TO_BE_DEPRECATED` or `deprecated: 100000.0` in Apple's SDKs. > [!NOTE] There is a bug in the DocC compiler that emits a diagnostic of the form: > > >⚠️ 'require(_:sourceLocation:performing:throws:)' isn't unconditionally deprecated > > This issue is being tracked already with rdar://141785948. Resolves #873.
Contributor
Author
|
@swift-ci test |
grynspan
commented
Dec 21, 2024
briancroom
approved these changes
Jan 2, 2025
grynspan
added a commit
that referenced
this pull request
Jan 2, 2025
…ed. (#875) These symbols should go through a transition period where they are documented as to-be-deprecated rather than being deprecated outright. My mistake. With this change applied, Xcode treats these macros as deprecated (deemphasizing them in autocomplete, for instance) and DocC marks them as deprecated in an unspecified Swift version, but no warning is emitted if they are used. This is consistent with API marked `API_TO_BE_DEPRECATED` or `deprecated: 100000.0` in Apple's SDKs. > [!NOTE] > There is a bug in the DocC compiler that emits a diagnostic of the form: > > >⚠️ 'require(_:sourceLocation:performing:throws:)' isn't unconditionally deprecated > > This issue is being tracked already with rdar://141785948. Resolves #873. - [x] Code and documentation should follow the style of the [Style Guide](https://github.com/apple/swift-testing/blob/main/Documentation/StyleGuide.md). - [x] If public symbols are renamed or modified, DocC references should be updated.
grynspan
added a commit
that referenced
this pull request
Jan 2, 2025
…precated. (#879) - **Explanation**: We should have marked these changes as to-be-deprecated, not hard-deprecated yet. - **Scope**: Swift 6.1, anybody using `#expect(throws:)`. - **Issues**: #873 - **Original PRs**: #875 - **Risk**: Low, this is mostly just documentation changes. - **Testing**: Automated testing. - **Reviewers**: @briancroom
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
These symbols should go through a transition period where they are documented as to-be-deprecated rather than being deprecated outright. My mistake.
With this change applied, Xcode treats these macros as deprecated (deemphasizing them in autocomplete, for instance) and DocC marks them as deprecated in an unspecified Swift version, but no warning is emitted if they are used. This is consistent with API marked
API_TO_BE_DEPRECATEDordeprecated: 100000.0in Apple's SDKs.Note
There is a bug in the DocC compiler that emits a diagnostic of the form:
This issue is being tracked already with rdar://141785948.
Resolves #873.
Checklist: