docs gate: the opt-in wording checks stop one of the six sentences that the #2439 documents removed
维护者通常 1 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 新手友好度
- 72/100
- Issue 类型
- 缺陷
- 描述清晰度
- 描述清楚
- 活跃度
- 活跃
- 领域
- documentation, testing
调研方向
Start with tools/docs_claims_check.sh and inspect the documents' change in #2439 to retrieve the six sentences and their source files. Extend the self-test to plant each sentence, report how many it examined, and confirm each is rejected with a diagnostic naming its file; run the gate on the current documents as the clean control. Done means all six are caught regardless of line wrapping, while the header states the two patterns it checks and that rewordings can pass.
由索引模型根据 Issue 内容生成。
描述
tools/docs_claims_check.sh has two checks for wording that says argument guards are opt-in (added with the documents of #2439: its self-test cases stale-strict-opt-in and stale-guard-state). An independent review of that change put back, one at a time, each of the six opt-in sentences the change removes, and ran the gate:
- red: the sentence of
docs/SYNTAX.md(says EIGS_STRICT=1 opts into invalid-argument errors; unset already enables guards); - green: the sentences of
README.md,docs/llms.txt,docs/LANGUAGE_CONTRACT.md,docs/COMPARISON.mdand the box ofdocs/BUILTINS.md.
Why: the first check matches one spelling on one line (the same sentence wrapped over two lines, as docs/LANGUAGE_CONTRACT.md had it, does not match), and the second needs "raises" or "rejects" near "under EIGS_STRICT=1" or "in strict mode", which the removed sentences do not have. Close rewordings pass too ("...raises only when EIGS_STRICT=1 is set", "Argument guards are opt-in: ...").
So a merge or an old branch that brings one of those sentences back is not stopped by the gate. The two self-test cases do go red on what they plant; the gap is what they do not plant.
Done when
- The six sentences that the documents' change of #2439 removed (take them from that change's diff, by a command) are each refused when put back into the file they came from, by a line that names the file; matching ignores how the sentence is wrapped. The self-test plants all six and prints how many it examined.
- The check says in its header what it holds (those six sentences, and the two patterns) and that it is not a reader of meaning: a reworded opt-in sentence passes. No sentence of the header claims more.
- The clean control: the documents as they are pass.
— Claude DevBox
- 主要语言
- C
- 星标
- 3
- 派生
- 7
- 平均合并
- 3 小时 28 分钟
- 30 天内合并 PR
- 270
环境准备
在浏览器里用你自己的 GitHub 账号启动这个项目的开发容器。
- 提供 Dockerfile 或 Docker Compose 文件
- 有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
InauguralSystems/EigenScript 的其他 Issue
-
area:gates kind:gate-defect
难度 2/5 1-3 小时 新手友好度 83/100
InauguralSystems/EigenScript#2476 ·
维护者通常 1 天内回复
-
area:gates needs-triage
难度 2/5 1-3 小时 新手友好度 78/100
InauguralSystems/EigenScript#2462 · 1 条评论 ·
维护者通常 1 天内回复
-
The hosted-RNG check refuses a clean tree that has a tracked file with a double quote in its name未关闭area:gates kind:gate-defect needs-triage
难度 2/5 1-3 小时 新手友好度 78/100
InauguralSystems/EigenScript#2461 · 1 条评论 ·
维护者通常 1 天内回复
-
area:gates kind:gate-defect needs-triage
难度 2/5 1-3 小时 新手友好度 86/100
InauguralSystems/EigenScript#2458 · 1 条评论 ·
维护者通常 1 天内回复
-
`http_post`: `headers` text with something after its JSON value now means no headers, without a word未关闭area:http kind:silent-wrong
难度 2/5 1-3 小时 新手友好度 72/100
InauguralSystems/EigenScript#2394 · 1 条评论 ·
维护者通常 1 天内回复
查看 InauguralSystems/EigenScript 的全部 Issue
相似的 Issue
-
难度 1/5 1 小时以内 新手友好度 92/100
flipperdevices/flipperzero-firmware#4520 ·
维护者通常 1 天内回复
-
area/build-framework kind/enhancement priority/low
难度 2/5 1-3 小时 新手友好度 77/100
yugabyte/yugabyte-db#38826 ·
维护者通常 1 天内回复
-
难度 1/5 1 小时以内 新手友好度 88/100
meshcore-dev/MeshCore#3891 · 1 条评论 ·
维护者通常 1 天内回复
-
bug grammar sev-3
难度 2/5 1-3 小时 新手友好度 76/100
-
status: needs-triage type: bug
难度 2/5 1-3 小时 新手友好度 75/100