Skip to content

Fix pg-native prepare example output and doc typos - #3823

Merged
charmander merged 1 commit into
brianc:masterfrom
toyeshhm:fix-doc-typos
Oct 20, 2026
Merged

charmander merged 1 commit into
brianc:masterfrom
toyeshhm:fix-doc-typos

Conversation

@toyeshhm

Copy link
Copy Markdown
Contributor

The pg-native client.prepare / client.execute example in packages/pg-native/README.md prepares SELECT $1::text as beans, but the output comment showed the row keyed by the statement name:

console.log(rows) // [{ "i_like_beans": "Brak" }]

Rows are keyed by column name, so the result is [{ "beans": "Brak" }]. packages/pg-native/test/query-async.js checks the same thing: it prepares SELECT $1::text as name and asserts rows[0].name.

Also fixes a few typos:

  • README.md: requring -> requiring
  • docs/pages/guides/upgrading.md: compatiblity -> compatibility
  • packages/pg-native/README.md: exteremly convienent -> extremely convenient
  • packages/pg-pool/README.md: releated -> related
  • packages/pg/README.md: "documentation or communicate it will require" -> "documentation or communication it will require" (matches the root README)

Docs only, no code changes.

The pg-native prepare/execute example aliases the column as `beans`,
so the rows are keyed by `beans`, not by the statement name
`i_like_beans`.

Also correct spelling and wording in the READMEs and upgrading guide:
requring -> requiring, compatiblity -> compatibility,
exteremly convienent -> extremely convenient, releated -> related,
and "documentation or communicate" -> "documentation or communication".
Copilot AI balanced review requested due to automatic review settings October 19, 2026 19:40

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@charmander
charmander merged commit 1ae5fd9 into brianc:master Oct 20, 2026
13 checks passed
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