Skip to content

Note in documentation when #expect(throws:) started returning a value. #980

New issue

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

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

Already on GitHub? # to your account

Merged

Conversation

grynspan
Copy link
Contributor

@grynspan grynspan commented Feb 27, 2025

DocC doesn't let us annotate our return type's availability separately from our macros' availability, and we can't include both the old symbols and new ones because it is ambiguous at compile time, so this PR explains in prose when the return types were added.

Checklist:

  • Code and documentation should follow the style of the Style Guide.
  • If public symbols are renamed or modified, DocC references should be updated.

DocC doesn't let us annotate our return type's availability separately from our
macros' availability, and we can't include both the old symbols and new ones
because it is ambiguous at compile time, so this PR explains in prose when the
return types were added.
@grynspan grynspan added the documentation 📚 Improvements or additions to documentation label Feb 27, 2025
@grynspan grynspan added this to the Swift 6.x milestone Feb 27, 2025
@grynspan grynspan requested a review from iamleeg February 27, 2025 15:35
@grynspan grynspan self-assigned this Feb 27, 2025
Copy link
Contributor

@iamleeg iamleeg left a comment

Choose a reason for hiding this comment

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

Thanks for adding this information!

@grynspan
Copy link
Contributor Author

@swift-ci test

@grynspan grynspan merged commit 66708a7 into main Feb 28, 2025
3 checks passed
@grynspan grynspan deleted the jgrynspan/note-when-return-value-added-to-expect-throws branch February 28, 2025 16:22
grynspan added a commit that referenced this pull request Mar 3, 2025
… a value. (#990)

- **Explanation**: Update documentation for modified macros to indicate
how they've changed in 6.1.
  - **Scope**: Documentation
  - **Issues**: N/A
- **Original PRs**: #980
  - **Risk**: None
  - **Testing**: N/A
  - **Reviewers**: @briancroom @iamleeg @stmontgomery
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
documentation 📚 Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants