Skip to content

docs(kernel): re-quote QueryOptionsV2's JSDoc after #7003's convergence edit - #7063

Merged
os-project-manager merged 1 commit into
mainfrom
claude/issue-7002-requote-queryoptionsv2-jsdoc
Aug 9, 2026
Merged

docs(kernel): re-quote QueryOptionsV2's JSDoc after #7003's convergence edit#7063
os-project-manager merged 1 commit into
mainfrom
claude/issue-7002-requote-queryoptionsv2-jsdoc

Conversation

@os-project-manager

Copy link
Copy Markdown
Collaborator

Fixes #7002

缺陷

PR #7003#6795)修改了 packages/client/src/index.tsQueryOptionsV2 的 JSDoc:它不再自称
"the recommended interface for data.find() queries"(这与 find() 自身的
@deprecated 标签自相矛盾),新文案是:

This is the vocabulary data.find() still accepts — find itself carries
@deprecated; new code should call data.query() instead.

content/docs/kernel/runtime-services/data-service.mdx 在两处逐字引用了旧句子并注明出处
("Canonical source"):

  • ### Two list entries, one preference 小节(原第 60 行)
  • ### \find` options: canonical and legacy` 小节(原第 101 行)

#7003 落地后,这两处引用不再与源文件逐字一致 —— 与 #6925(searchable-fields 提示语)是同一类缺陷,只是换了一对文件。

修复

  • 两处引用都改为当前 mainpackages/client/src/index.ts 的实际 JSDoc 文本
    the vocabulary \data.find()` still accepts`),已用脚本做字节级比对(见下)。
  • 两处引用周围的行文本身也在用自己的话暗示"推荐"(names ... for callers that stay on it /
    declares which of the two to write),一并改写为中性描述,避免"引用改对了、结论仍旧过时"的
    半修复。第二处结尾的 "so the recommendation is the SDK's own" 保持不动 —— 它指向的是
    QueryOptions 自身未变的 @deprecated 标签里 "Prefer QueryAST fields directly" 的指示,
    这个建议依然成立。
  • packages/client 本身未做任何改动(源文件在 fix(client): QueryOptionsV2 no longer calls itself the recommended interface for deprecated data.find() #7003 合并后已经是正确的)。

排查范围

验证

文档类改动本仓库没有测试断言,按要求做字节级比对而非人工目测(脚本见 PR 描述末尾),并跑了仓库的文档
门禁:

$ pnpm check:doc-authoring
✓ check-doc-authoring self-test: ... all hold.
✓ doc authoring guard: 374 files clean — no bare metadata literals.

$ pnpm check:docs-audit-scope
✓ affected-docs self-test: 56 cases pass.
✓ check-audit-scope self-test: 22 cases pass.
✓ docs-accuracy-audit scope is in sync with content/docs/: 179 hand-written doc(s).
✓ release-owned pages are in scope and read-only: 9 page(s) under content/docs/releases/ review-only.

$ node scripts/check-nul-bytes.mjs
check-nul-bytes: OK (scanned 6517 tracked text file(s); ... no raw ASCII control bytes).

check-links(lychee)是本仓库对 content/docs/** 的 advisory 链接门禁;本次改动未触碰任何链接语法(仅改了两句引用文字),容器内没有 lychee 二进制可本地跑,留给 CI 的 advisory 通道。

边界

变更集

纯文档改动,不影响任何运行时行为,判定为 skip-changeset(会在 PR 上手动打标签,并在打标签后回读确认)。


Byte-comparison script used (scratchpad, not committed):

// verify-quotes.mjs — asserts each doc fragment is an exact substring of the
// normalized QueryOptionsV2 JSDoc on this branch, and that the stale sentence
// is gone from both the doc and the source.

Output: ALL CHECKS PASSED.


Generated by Claude Code

…ce edit

Fixes #7002

PR #7003 (#6795) reworded QueryOptionsV2's JSDoc in
packages/client/src/index.ts: it no longer calls itself "the recommended
interface for `data.find()` queries" — that self-description was a
contradiction with `find()`'s own `@deprecated` tag. The new sentence reads
"This is the vocabulary `data.find()` still accepts" and is explicitly not a
recommendation.

content/docs/kernel/runtime-services/data-service.mdx quoted the old sentence
verbatim, attributed to that source, in two spots. Both are re-quoted from the
current main JSDoc text, and in both spots the surrounding prose that
editorialized on the old "recommended" framing is corrected alongside the
quote — a corrected quote under an unfixed claim would still be a half-fix.

No other content/docs/** or skills/** location quotes the stale sentence
(grepped repo-wide). .changeset/query-options-v2-not-a-recommendation.md also
contains the phrase, but only as a past-tense description of what #7003 fixed
— that's a legitimate changelog record, not a stale live quote, and is left
untouched.

Claude-Session: https://claude.ai/code/session_01F8q5J1MQyocgtNspb15fSn

Co-authored-by: Claude <noreply@anthropic.com>
@vercel

vercel Bot commented Aug 9, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

1 Skipped Deployment
Project Deployment Actions Updated (UTC)
objectstack Ignored Ignored Aug 9, 2026 1:02pm

Request Review

@os-project-manager os-project-manager added the skip-changeset PR has no user-facing published change; bypasses the changeset gate label Aug 9, 2026 — with Claude
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Aug 9, 2026
@os-project-manager
os-project-manager marked this pull request as ready for review August 9, 2026 13:32
@os-project-manager
os-project-manager added this pull request to the merge queue Aug 9, 2026
Merged via the queue into main with commit fa6b436 Aug 9, 2026
25 checks passed
@os-project-manager
os-project-manager deleted the claude/issue-7002-requote-queryoptionsv2-jsdoc branch August 9, 2026 13:44
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 size/xs skip-changeset PR has no user-facing published change; bypasses the changeset gate

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[finding] data-service.mdx quotes the pre-#6795 "recommended interface" sentence verbatim — stale after #6795's convergence edit

2 participants