Clarify the outcome of applying a timeLimit trait to a suite. #1225
Conversation
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
stmontgomery
approved these changes
Jul 15, 2025
iamleeg
added a commit
that referenced
this pull request
Jul 17, 2025
Make it clearer that the time limit applies to each test or case in the suite, not to the overall runtime of the test suite. ### Motivation: I received feedback that a developer couldn't work out whether `.timeLimit(_:)` on a suite limits each test, or the whole suite. ### Modifications: - Add documentation that explains that the time limit applies to each test or case in a parameterized test, when you apply it to a suite. - Remove some passive-voice sentences in the same documents so that it's clearer what a developer does, and what the testing library does for them. ### Checklist: - [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.
iamleeg
added a commit
that referenced
this pull request
Jul 17, 2025
…1225) (#1229) - **Explanation**: Update the documentation for the `timeLimit` trait to clarify that applying the trait to a suite means that each test in that suite gets the time limit. - **Scope**: Documentation changes only. - **Issues**: - **Original PRs**: #1225 - **Risk**: Documentation changes only, so very low risk. - **Testing**: N/A - **Reviewers**: @stmontgomery
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Make it clearer that the time limit applies to each test or case in the suite, not to the overall runtime of the test suite.
Motivation:
I received feedback that a developer couldn't work out whether
.timeLimit(_:)on a suite limits each test, or the whole suite.Modifications:
Checklist: