docs gate: the guard-state check reads a sentence across a Markdown block boundary and refuses a correct paragraph
维护者通常 1 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 2/5
- 预计耗时
- 1-3 小时
- 新手友好度
- 83/100
- Issue 类型
- 缺陷
- 描述清晰度
- 描述清楚
- 活跃度
- 活跃
- 技术栈
- bash, c, markdown
调研方向
从 tools/docs_claims_check.sh 及其自测试用例开始,然后检查 guard-state 检查如何分隔 Markdown 文本块和句子。在包含 docs/BUILTINS.md 中示例段落的构建树上运行 bash tools/docs_claims_check.sh;完成标准是该检查在此处通过,同时关于参数类型错误的说法在段落和表格单元格中仍会报错。
由索引模型根据 Issue 内容生成。
描述
tools/docs_claims_check.sh judged a correct sentence about arithmetic results as a claim about opt-in argument guards, because the unit it reads as "a sentence" ran across a Markdown block boundary: it began in the table above the paragraph, whose last row has no full stop.
Found while writing #2444's documents. That change reflowed its paragraph and left the checker alone.
Shows it
In docs/BUILTINS.md, put this paragraph directly under the table of the "Command-Line Arguments" section (at the head of "Scalar Math"), and run bash tools/docs_claims_check.sh on a built tree:
Scalar arithmetic and its existing list forms accept infinity and NaN: with
`EIGS_STRICT` unset or `0`, the result follows IEEE 754 and C libm; with
`EIGS_STRICT=1`, a non-finite result raises through the existing arithmetic or
domain trap, while a finite result answers.
The gate is red at that line, although the paragraph says nothing about argument guards. Split into shorter sentences, the same statement passes.
Done when
- A heading, a table and a blank line end the unit of prose the guard-state check reads; a sentence does not begin in the block before.
- The paragraph above passes where it stands.
- A real statement that wrong-typed arguments are refused only under
EIGS_STRICT=1stays red, in a paragraph and in a table cell; both are self-test cases.
— 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 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 天内回复
-
area:docs good first issue kind:docs-drift
难度 2/5 1-3 小时 新手友好度 70/100
InauguralSystems/EigenScript#2360 ·
维护者通常 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