Skip to content

docs/providers/couchbase.md: replace 30 stale line-number citations with named citations #591

Description

@cevheri

docs/providers/couchbase.md cites code by line number in 30 places. Nothing measures those numbers, so a citation is true only until the next insertion above it, and nothing goes red when it stops being true. A method name is greppable and survives an insertion, so it needs no correction round at all.

Measured 2026-09-06. Of the 5 citations that name a method beside the line, 3 point at the wrong line today:

  • connect() cited :335, declared at :399
  • getCapabilities() cited :276, declared at :299
  • getLabels() cited :293, declared at :345

The 30 citations span nine files: index.ts (10), http-transport.ts (7), introspect.ts (5), transport.ts (3), and one each in keyspace.ts, connection-string-parser.ts, factory.ts, use-query-execution.ts and src/lib/db/types.ts. This is the largest of the remaining docs; take it only if you want the long one.

Fix. Rewrite each citation to name the declaration instead of its coordinate, keeping the link to the file:

`getSchema()` ([`index.ts`](../../src/lib/db/providers/document/couchbase/index.ts))

docs/providers/mongodb.md (#581), mssql.md, oracle.md and trino.md are already in this shape and are the model to copy. Then add the doc to the NAMED_CITATIONS list in tests/unit/provider-docs-monitoring-citations.test.ts, with src/lib/db/providers/document/couchbase/index.ts as its source and the method names the doc now uses. That list's two tests then assert the doc carries no .ts:<line> anywhere and that every name it cites is really declared, so this cannot rot again. Read that file's header comment first: it explains the policy and why it is pinned rather than the coordinates.

Done when grep -oE '\.ts:[0-9]+' docs/providers/couchbase.md returns nothing, the doc appears in NAMED_CITATIONS, and the suite is green. One doc plus one list entry, no product code.

Tracked in docs/BACKLOG.md as DOC4.


Curated for Hacktoberfest 2026. Comment to claim it before you start so two people do not work on the same issue. A PR must reference this issue and land with its tests in the same change; see CONTRIBUTING.md. Repo rules that apply: run bun run test (never bare bun test), and the 100% line-coverage gate must stay green. Local bun run test also needs the helm binary on PATH for unrelated chart tests - see #570 if it bites.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationgood first issueGood for newcomershacktoberfestCurated for Hacktoberfest; pick up cold, tests required

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions