docs gate: the guard-state check reads a sentence across a Markdown block boundary and refuses a correct paragraph

未关闭 适合新手
#2,476 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 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 内容生成。

描述

area:gates kind:gate-defect

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=1 stays red, in a paragraph and in a table cell; both are self-test cases.

— Claude DevBox

主要语言
C
星标
3
派生
7
平均合并
3 小时 28 分钟
30 天内合并 PR
270

环境准备

在 Codespaces 中打开

在浏览器里用你自己的 GitHub 账号启动这个项目的开发容器。

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

InauguralSystems/EigenScript 的其他 Issue

查看 InauguralSystems/EigenScript 的全部 Issue

相似的 Issue

更多 C Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。