docs(kernel): re-quote QueryOptionsV2's JSDoc after #7003's convergence edit - #7063
Merged
os-project-manager merged 1 commit intoAug 9, 2026
Merged
Conversation
…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>
|
The latest updates on your projects. Learn more about Vercel for GitHub. 1 Skipped Deployment
|
os-project-manager
marked this pull request as ready for review
August 9, 2026 13:32
os-project-manager
deleted the
claude/issue-7002-requote-queryoptionsv2-jsdoc
branch
August 9, 2026 13:44
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #7002
缺陷
PR #7003(#6795)修改了
packages/client/src/index.ts里QueryOptionsV2的 JSDoc:它不再自称"the recommended interface for
data.find()queries"(这与find()自身的@deprecated标签自相矛盾),新文案是: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 提示语)是同一类缺陷,只是换了一对文件。
修复
main上packages/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 合并后已经是正确的)。排查范围
content/docs/**与skills/**中 "recommended interface" /QueryOptionsV2:只有这一个文件的两处命中,未发现其他同类过期引用。
.changeset/query-options-v2-not-a-recommendation.md(fix(client): QueryOptionsV2 no longer calls itself the recommended interface for deprecated data.find() #7003 自带的 changeset)里也出现了旧句子,但那是对"修了什么"的过去式历史记录(changelog),本身仍然正确,不属于本 issue 范围,未改动。
验证
文档类改动本仓库没有测试断言,按要求做字节级比对而非人工目测(脚本见 PR 描述末尾),并跑了仓库的文档
门禁:
check-links(lychee)是本仓库对content/docs/**的 advisory 链接门禁;本次改动未触碰任何链接语法(仅改了两句引用文字),容器内没有 lychee 二进制可本地跑,留给 CI 的 advisory 通道。边界
packages/client、docs/adr/**、content/docs/releases/**。content/docs/**是 domain-boundary-contested 路径(域标签词表有两个未入表条目:domain:spec-tooling(在用,文件面与 devx 完全重叠)与domain:ui(一例,与repo:objectui重复) #5469,尚无定论),本 PR 的 diff 刻意收得很紧——只改了两处引用文本 + 其直接上下文的措辞,没有触及页面结构、标题或其余段落。
@objectstack/verify's bootStack ignores an app'sisDefaultpermission set, while the CLI honours it — after #5491 a dogfood app cannot test its own declared baseline #7001(packages/verify的bootStack/fallbackPermissionSet缺陷)完全没有交集,已核对过其 issue 内容,两者路径不重叠。
变更集
纯文档改动,不影响任何运行时行为,判定为
skip-changeset(会在 PR 上手动打标签,并在打标签后回读确认)。Byte-comparison script used (scratchpad, not committed):
Output:
ALL CHECKS PASSED.Generated by Claude Code