Conversation
Closes gofr-dev#3861 - Correct 'serup' to 'setup' in Couchbase documentation - Correct 'unadressable' to 'unaddressable' in gRPC test comment No production code changes, docs/test-only.
aryanmehrotra
left a comment
There was a problem hiding this comment.
Both typos are real and both are still on development as of today, so this is worth taking. Verified:
docs/datasources/couchbase/page.md:41— "serup"pkg/gofr/grpc_test.go:302— "unadressable"
Those are the only two occurrences in the repo, so the sweep is complete, and unaddressable matches the spelling already used at grpc_test.go:290. CI is green and the branch is clean against development.
One change before I merge it.
docs/datasources/couchbase/page.md:41 — the verb form is two words
"setup" is the noun; the verb is "set up". Correcting the typo to "setup" leaves the sentence ungrammatical, and it would be the only to setup in docs/ — the three existing instances are all to set up (websocket/page.md:18, load-testing/page.md:122, connecting-redis/page.md:17).
Don't forget to set up the Couchbase cluster in Couchbase Web Console first.Title
Could you reword it to Conventional Commits? The title is what lands in history on squash. Something like:
fix: correct "serup" and "unadressable" typos
One note, not a request
Worth knowing why this reached development at all: our typos check runs across the whole repo, but crate-ci/typos v1.50 doesn't carry either word — it knows adressable -> addressable but not the un-prefixed form, and serup isn't in its dictionary. That's why the check is green on development today with both typos still present. If we want the linter to hold this line in future, a custom correction in typos.toml does it:
[default.extend-words]
unadressable = "unaddressable"Separate concern from this PR though — please don't widen the diff for it.
Everything else is approvable. Fix the set up line and the title and I'll merge.
|
|
||
| Users can easily inject a driver that supports this interface, providing usability without compromising the extensibility to use multiple databases. | ||
| Don't forget to serup the Couchbase cluster in Couchbase Web Console first. [Follow for more details](https://docs.couchbase.com/server/current/install/getting-started-docker.html#section_jvt_zvj_42b). | ||
| Don't forget to setup the Couchbase cluster in Couchbase Web Console first. [Follow for more details](https://docs.couchbase.com/server/current/install/getting-started-docker.html#section_jvt_zvj_42b). |
There was a problem hiding this comment.
"setup" is the noun; the verb is "set up". This fixes the typo but leaves the sentence ungrammatical, and it would be the only to setup in docs/ — the three existing instances are all to set up.
| Don't forget to setup the Couchbase cluster in Couchbase Web Console first. [Follow for more details](https://docs.couchbase.com/server/current/install/getting-started-docker.html#section_jvt_zvj_42b). | |
| Don't forget to set up the Couchbase cluster in Couchbase Web Console first. [Follow for more details](https://docs.couchbase.com/server/current/install/getting-started-docker.html#section_jvt_zvj_42b). |
Description
Changes:
docs/datasources/couchbase/page.md: "serup" → "setup"pkg/gofr/grpc_test.go: "unadressable" → "unaddressable" (consistent with existing correct spelling on line 286)Checklist:
goimportsandgolangci-lint.Thank you for your contribution!