docs: polish user-facing text for clarity and consistency - #839
Merged
Conversation
Comprehensive copy review across README, docs, and user-facing text. American English grammar and style, postgres-ai terminology and units, sentence-case headings, SEO/LLM-friendly opening lines. No code, commands, or technical values changed. Relates to #838
Adds a missing meta description to wasm/index.html for search snippets and LLM summaries, and fixes one remaining British spelling in docs/GLOSSARY.md for in-file consistency. Relates to #838
11 tasks
Two pre-existing manual_assert_eq denials in test code (src/config.rs and src/ash/sampler.rs) fail the -D warnings clippy gate. This branch did not introduce them, but the PR merge commit surfaces the latent lint. Apply clippy's exact suggested rewrite (assert! == -> assert_eq!) at both sites only. Test-only; unrelated to the prose polish.
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.
This PR is a copy-editing pass over the user-facing text in the repository. Every change is prose only: grammar, American-English spelling, sentence-case headings, terminology, and clearer opening lines for search snippets and LLM summaries. No code, commands, SQL, config values, or numbers were touched.
What changed
--generate-wrappersdoc-comment ("e.g." -> "e.g.,"). No runtime string, flag, default, or logic changed; verified no test asserts on it.Not changed
No code, commands, SQL, config values, flags, identifiers, URLs, version tags, benchmark numbers (222 of 232, 10 skipped), badges, demo GIF paths, tables, or quoted psql/rpg output were changed. Pre-existing em dashes were preserved, not churned. For the two source files (src/main.rs, wasm/index.html) only comment/message text changed, and grep confirmed no test asserts on those strings.
Relates to #838
Note: commit eec6d95 (
style(test): satisfy clippy assert_eq lint) is a test-only change required to get pre-existing clippy passing under-D warnings. Twomanual_assert_eqdenials in test code (src/config.rs, src/ash/sampler.rs) were surfaced by the PR merge commit; they are unrelated to the prose polish.