Cleaning recently changed docs #924
Merged
Conversation
This file contains 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
iamleeg
requested review from
stmontgomery,
grynspan,
briancroom,
SeanROlszewski and
suzannaratcliff
as code owners
stmontgomery
added
documentation
Comment on lines
18
to
22
| /// Use this type to specify a test timeout with ``TimeLimitTrait``. | ||
| /// Use this type instead of Swift's built-in `Duration` | ||
| /// type because the testing library doesn't support high-precision, | ||
| /// arbitrarily short durations for test timeouts. | ||
| /// The smallest allowed unit of time is minutes. |
There was a problem hiding this comment.
Purely stylistic, but it seems like we could re-flow the sentences here to condense these lines
There was a problem hiding this comment.
I re-worded this to avoid saying "Use this type" twice and it ended up just as long, but see what you think.
Comment on lines
73
to
75
| /// The testing library can use a shorter time limit than that specified by | ||
| /// `timeLimit` may be reduced if it's configured to enforce a maximum | ||
| /// per-test limit. When you configure a maximum per-test limit, the time |
There was a problem hiding this comment.
I think the first sentence of this paragraph was only partly reworded and needs another look
There was a problem hiding this comment.
OK had another go at this paragraph, see what you think.
Sources/Testing/Traits/Trait.swift
Outdated
Comment on lines
53
to
56
| /// Get this trait's scope provider for the specified test and/or test case, | ||
| /// if any. | ||
| /// Get this trait's scope provider for the specified test or test case. |
There was a problem hiding this comment.
The "and/or" was there because, there is always a Test passed, it's just the Test.Case parameter which is optional. Any ideas for a better way to phrase that? Saying "test or test case" makes it sound like it's one or the other.
There was a problem hiding this comment.
Right, good point. I avoided and/or because it's difficult for readers of English as a second language. I've gone with "test, and optional test case". I'm not sure I'm entirely happy with that but maybe it helps advance the discussion :).
grynspan
reviewed
Jan 24, 2025
grynspan
reviewed
Jan 24, 2025
grynspan
reviewed
Jan 24, 2025
grynspan
reviewed
Jan 27, 2025
grynspan
reviewed
Jan 27, 2025
grynspan
reviewed
Jan 27, 2025
grynspan
reviewed
Feb 7, 2025
grynspan
reviewed
Feb 7, 2025
grynspan
reviewed
Feb 7, 2025
grynspan
reviewed
Feb 7, 2025
| /// This means that by default, a suite trait will _either_ provide its | ||
| /// custom scope once for the entire suite, or once per-test function it | ||
| /// contains. | ||
| /// is `true`, then this method returns `nil`, and the suite trait |
There was a problem hiding this comment.
This discussion only applies to suite traits (it's saying "if the suite is recursive, then this function is recursively called for tests in the suite.")
There was a problem hiding this comment.
@stmontgomery I find this whole discussion somewhat confusing. Feels like we need a flowchart.
grynspan
reviewed
Feb 7, 2025
grynspan
reviewed
Feb 7, 2025
grynspan
reviewed
Feb 7, 2025
grynspan
reviewed
Feb 7, 2025
grynspan
reviewed
Feb 7, 2025
grynspan
reviewed
Feb 7, 2025
grynspan
reviewed
Feb 7, 2025
grynspan
reviewed
Feb 7, 2025
grynspan
approved these changes
Feb 13, 2025
iamleeg
added a commit
that referenced
this pull request
Feb 13, 2025
Improving the style and explanation of recent additions to the documentation. The recent changes to test traits are great, and come with some very nice documentation. I've done what I can to improve the style and the wording to make it easier to understand, and to make the style consistent with other documentation in the project. Changed the documentation for `Trait` and associated types. There are no behavioral changes in this PR, but I hope that the existing behavior is easier to use with better documentation. - [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
Feb 13, 2025
Improving the style and explanation of recent additions to the documentation. The recent changes to test traits are great, and come with some very nice documentation. I've done what I can to improve the style and the wording to make it easier to understand, and to make the style consistent with other documentation in the project. Changed the documentation for `Trait` and associated types. There are no behavioral changes in this PR, but I hope that the existing behavior is easier to use with better documentation. - [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
Feb 13, 2025
Improving the style and explanation of recent additions to the documentation. The recent changes to test traits are great, and come with some very nice documentation. I've done what I can to improve the style and the wording to make it easier to understand, and to make the style consistent with other documentation in the project. Changed the documentation for `Trait` and associated types. There are no behavioral changes in this PR, but I hope that the existing behavior is easier to use with better documentation. - [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.
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.
Improving the style and explanation of recent additions to the documentation.
Motivation:
The recent changes to test traits are great, and come with some very nice documentation. I've done what I can to improve the style and the wording to make it easier to understand, and to make the style consistent with other documentation in the project.
Modifications:
Changed the documentation for
Traitand associated types.Result:
There are no behavioral changes in this PR, but I hope that the existing behavior is easier to use with better documentation.
Checklist: