Skip to content

docs: fix stale Go migration link text, import path, and a typo - #1147

Open
toyeshhm wants to merge 1 commit into
pressly:mainfrom
toyeshhm:fix-doc-typos
Open

toyeshhm wants to merge 1 commit into
pressly:mainfrom
toyeshhm:fix-doc-typos

Conversation

@toyeshhm

Copy link
Copy Markdown

The Go Migrations section of the README links to a "sample Go migration 00002_users_add_email.go file", but the link points to examples/go-migrations/00002_rename_root.go, the code sample below it is the rename_root migration, and no 00002_users_add_email.go exists in the repo. Changed the link text to match the file.

Step 2 of the same section said to import github.com/pressly/goose; the module path is github.com/pressly/goose/v3 (as in go.mod and the sample right below), so updated that too.

Also fixes one typo in doc/dialect-clickhouse.md: "databas engine" -> "database engine".

Docs-only change, no behaviour change.

- README: the sample Go migration link said 00002_users_add_email.go,
  but it points to (and the sample shows) 00002_rename_root.go, and no
  file by the old name exists
- README: Go migrations step 2 said to import github.com/pressly/goose;
  the module path is github.com/pressly/goose/v3, as used in the sample
  below it
- doc/dialect-clickhouse.md: "databas engine" -> "database engine"
Copilot AI balanced review requested due to automatic review settings October 17, 2026 00:09

Copilot AI 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.

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

An organization owner can choose the repository organization as the billing source for reviews requested by members with a paid Copilot license. Learn about Copilot code review billing.

This branch has not been deployed

No deployments
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.

2 participants