Skip to content

docs(providers): drop dead getPlaceholder mentions - #642

Merged
cevheri merged 1 commit into
libredb:mainfrom
XiaoZ-0218:fix/docs-remove-getPlaceholder-640
Sep 8, 2026
Merged

docs(providers): drop dead getPlaceholder mentions#642
cevheri merged 1 commit into
libredb:mainfrom
XiaoZ-0218:fix/docs-remove-getPlaceholder-640

Conversation

@XiaoZ-0218

Copy link
Copy Markdown
Contributor

Summary

Fixes #640

Keep engine bind facts; align notes with clickhouse after libredb#304.
@cevheri cevheri added documentation Improvements or additions to documentation enhancement New feature or request labels Sep 8, 2026
@cevheri
cevheri self-requested a review September 8, 2026 07:13
@cevheri

cevheri commented Sep 8, 2026

Copy link
Copy Markdown
Member

Merging this. Thank you, and welcome.

The easy way to close #640 was to delete six lines. You did the harder and better thing: every site kept the fact and dropped only the dead name. @p1 and :1 are still what those drivers send, Druid still binds ?, and the search providers still refuse positional parameters, so a reader loses nothing. Copying clickhouse.md's shape for the three table rows was the right call.

What I checked: grep -rn getPlaceholder docs/ src/ returns nothing, the merge onto today's main is clean, the citation guard stays green, and your two search-doc paragraphs are byte-identical, which keeps elasticsearch.md and opensearch.md parallel the way the suite expects.

One thing worth knowing, and it is not a criticism of this PR. Nothing measures your fix: the suite never mentions getPlaceholder, so the name could come back and no test would go red. That is why these six sites went stale unnoticed in the first place. A citation is only safe once something fails when it stops being true, which is the whole idea behind tests/unit/provider-docs-monitoring-citations.test.ts.

The issue also under-counted the problem, and that was my mistake, not yours. docs/ADDING_A_PROVIDER.md still credits SQLBaseProvider with "placeholder style" and docs/DATABASE_PROVIDERS.md with "placeholder generation". My grep missed both because they paraphrase the name instead of writing it. I am filing that with the guard attached. If you want to take it, say so and it is yours.

Good first contribution.

@cevheri
cevheri merged commit 16b0361 into libredb:main Sep 8, 2026
22 checks passed
@XiaoZ-0218

Copy link
Copy Markdown
Contributor Author

Happy to take that follow-up when you file it.

@cevheri

cevheri commented Sep 8, 2026

Copy link
Copy Markdown
Member

@XiaoZ-0218 take it: #647

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

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs(providers): five docs cite getPlaceholder(), a method deleted in #304

2 participants