docs: polish the README intro and fix a non-compiling CHANGELOG snippet - #88
Merged
Conversation
The description was one 40-word sentence listing four features by comma, then a second sentence repeating the Swift, iOS and macOS versions that the badges state directly above it. Split into three short lines and dropped the version sentence as redundant. Also removed a stray second `---` above the Features heading, left behind when the README was split into separate documents.
The switch had comment-only case bodies:
case .cssGenerationFailed:
// fontColor or linkColor holds an invalid hex value ...
case .webViewConfigurationFailed:
Swift rejects that with "'case' label in a 'switch' should have at least one
executable statement", so anyone copying the snippet hit a compile error.
Added the missing `break` to both.
Same defect was fixed in the 3.1.0 release notes. Scanned every ```swift block
across README, CHANGELOG, CONTRIBUTING and docs/ for the pattern; these two were
the only occurrences.
NuPlay
added a commit
that referenced
this pull request
Aug 29, 2026
…et (#88) The description was one 40-word sentence listing four features by comma, followed by a second sentence repeating the Swift, iOS and macOS versions that the badges state directly above it. Split into three short lines and dropped the version sentence as redundant. Removed a stray second `---` above the Features heading, left behind when the README was split into separate documents. Gave the documentation table a header row. It was written with empty header cells, and GitHub still renders the header, so it showed as a blank grey strip above the first row. The CHANGELOG error-handling snippet had comment-only case bodies, which Swift rejects with "'case' label in a 'switch' should have at least one executable statement". Added the missing `break` to both cases.
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
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.
Follow-up to #87.
README intro
The description was one 40-word sentence listing four features by comma, followed by a second sentence repeating the Swift, iOS and macOS versions that the badges state directly above it.
Split into three short lines. The version sentence is dropped as redundant with the badges.
Before
After
Duplicate divider
A stray second
---sat above the Features heading, left behind when the README was split in #87.Checked every other document for the same pattern — no further occurrences.
CHANGELOG snippet did not compile
The error-handling example had comment-only case bodies:
Swift rejects that with "'case' label in a 'switch' should have at least one executable statement", so copying the snippet produced a compile error. Added the missing
breakto both cases.The same defect was fixed in the 3.1.0 release notes. Every ```swift block across
README, `CHANGELOG`, `CONTRIBUTING` and `docs/` was scanned for the pattern — these two were the only occurrences.