docs clean up and fix up - spelling, grammar, and style guide alignment#2
Merged
Conversation
heckj
requested review from
agnosticdev,
ekinnear,
kkuk24,
rpaulo and
tfpauly
as code owners
tfpauly
requested changes
Jun 9, 2026
| final class EndpointFlow: CustomDebugStringConvertible { | ||
|
|
||
| /// Datapath logging | ||
| /// The data path logging state. |
Collaborator
There was a problem hiding this comment.
Suggested change
| /// The data path logging state. | |
| /// State used to emit logs on the data path. |
- Restore Connection.swift and Parameters.swift to original wording
to keep them aligned with the public SDK headerdoc.
- Drop incorrect "on behalf of" phrasing in BottomProtocol.swift and
OneToOneProtocol.swift; rewrite to describe what each function
returns to or sends from the upper protocol.
- Apply line suggestions:
- IPv4Address/IPv6Address: use 'IPv4 "any" address' / 'IPv6 "any"
address' instead of "any-address".
- EndpointFlow: clarify log property doc and restore "Cancelled"
spelling to match the public API.
- PathProperties: drop hyphen from "link-quality measurement".
tfpauly
approved these changes
Jun 9, 2026
agnosticdev
reviewed
Jun 9, 2026
agnosticdev
left a comment
agnosticdev
left a comment
Collaborator
There was a problem hiding this comment.
Just a few items, thank you for doing this!
tfpauly
reviewed
Jun 9, 2026
tfpauly
reviewed
Jun 9, 2026
tfpauly
reviewed
Jun 9, 2026
Co-authored-by: Tommy Pauly <tpauly@apple.com>
agnosticdev
approved these changes
Jun 9, 2026
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.
variety of docs updates - fixing spelling, grammar, voice, tense, and alignment with Apple's style guides