Skip to content

Docs/typos and comment fixes#3

Merged
heckj merged 7 commits into
mainfrom
docs/typos-and-comment-fixes
Jun 9, 2026
Merged

Docs/typos and comment fixes#3
heckj merged 7 commits into
mainfrom
docs/typos-and-comment-fixes

Conversation

@heckj

@heckj heckj commented Jun 9, 2026

Copy link
Copy Markdown
Contributor

A collection of fixes for typos, grammar, and adherence to Apple style guidelines for API and documentation content.

heckj added 5 commits June 9, 2026 07:37
Apply the mechanical-tier findings from the swift-tls style review:

- Misspellings: recieved (8 sites), transcipt (3), acces, elemnt,
  offererd, CertificateMessag, nulTerminated cross-references.
- Rename receievedServerFinished -> receivedServerFinished and
  update its single caller. Source-breaking; no deprecated alias.
- Fragments: "This exporter master secret" -> "This is the exporter
  master secret" in three KeyScheduler sites.
- Doubled words: "to to" (twice), "the the signature".
- Punctuation: stray "(" in Clock.swift fatalError, trailing commas
  after closing parens, trailing space in log string, comma -> period,
  missing terminal periods, orphan //, double space and missing article
  in README.
- Wording: "perform" -> "performing", "and" -> "an", "is await" ->
  "is awaiting" (two files), "a the resumption psk" -> "the resumption
  psk", "didnt" -> "didn't", "any" -> "and" in EmbeddedPrint, log
  string "x25519-MLKEM768" -> "x25519MLKEM768" to match the canonical
  type spelling.
- Log capitalization: "likely epsk" -> "Likely epsk", "aborting
  handshake" -> "Aborting handshake".
- fragments, run-ons, passive voice, ambiguous pronouns, and contradictions
- Reconcile the contradictory SwiftTLSOpaqueReferenceKey init and the supportsUnverifiedX509 list.

@agnosticdev agnosticdev left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Just one more change. Thank you for going through and fixing all of these!

Comment thread Sources/EmbeddedPrint.swift Outdated
Comment thread Sources/EmbeddedPrint.swift Outdated
Comment thread Sources/EmbeddedPrint.swift Outdated
Comment thread Sources/Cryptography/KeyScheduler.swift Outdated
Comment thread Sources/Cryptography/KeyScheduler.swift Outdated
Comment thread Sources/Cryptography/KeyScheduler.swift Outdated
Comment thread Sources/Cryptography/KeyScheduler.swift Outdated
Comment thread Sources/Cryptography/KeyScheduler.swift Outdated
Comment thread Sources/Cryptography/KeyScheduler.swift Outdated
Comment thread Sources/Cryptography/KeyScheduler.swift Outdated
Comment thread Sources/Handshake/HandshakeState.swift Outdated
Comment thread Sources/Handshake/HandshakeStateMachine.swift Outdated
Comment thread Sources/Handshake/HandshakeStateMachine.swift Outdated
@heckj heckj merged commit 91c75fd into main Jun 9, 2026
19 checks passed
@heckj heckj deleted the docs/typos-and-comment-fixes branch June 9, 2026 16:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants