Avoid passive voice and clarify macro in exit test docs. #1243
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
iamleeg
requested review from
stmontgomery,
grynspan,
briancroom and
suzannaratcliff
as code owners
grynspan
added
documentation
grynspan
requested changes
Jul 29, 2025
| and [`Codable`](https://developer.apple.com/documentation/swift/codable). The | ||
| testing library encodes each value using [`encode(to:)`](https://developer.apple.com/documentation/swift/encodable/encode(to:)) | ||
| in the parent process, and decodes it using [`init(from:)`](https://developer.apple.com/documentation/swift/decodable/init(from:)) | ||
| in the child process, before passing it to the exit test body. |
There was a problem hiding this comment.
The new commas are incorrect, at least the way I was taught (circa 1854.)
There was a problem hiding this comment.
The words "and", and "before", are acting as coordinating conjunctions between independent clauses in this sentence. While you can always find a grammar "rule" that says you should use a comma in the same place that another "rule" says you shouldn't use one, I think the commas separate the independent clauses here.
There was a problem hiding this comment.
We could split the difference and make this a list of steps instead?
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.
Review recent changes in the exit test documentation.
Motivation:
@grynspan asked me to review #1165 but it was already merged by the time I got there, so here are my review suggestions as a fresh PR.
Modifications:
Checklist: