docs: stand-in rows of BUILTINS.md (18 without one, bool arguments unstated) and three stale sentences on the bench gate

未关闭
#2,409 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
3/5
预计耗时
1-2 天
新手友好度
58/100
Issue 类型
文档
描述清晰度
描述清楚
活跃度
活跃
技术栈
bash, c
领域
documentation

调研方向

Read docs/BUILTINS.md, docs/PERFORMANCE.md, .github/workflows/codspeed.yml, and the builtin guards under src/. Derive the guarded builtins and benchmark counts or thresholds with commands, include those commands and outputs in the PR, then update the named documentation and comments. Run bash tools/docs_claims_check.sh; done means it passes and every listed documentation claim matches the tree.

由索引模型根据 Issue 内容生成。

描述

area:docs found-by:critic kind:docs-drift

Found by the blind review of #2402 (two passes), beside that change's bar. Each was seen on main's text; none is new with #2402.

docs/BUILTINS.md, the rows of builtins with a lenient stand-in. The file says near its top that a row whose builtin answers with a stand-in under EIGS_STRICT=0 names that stand-in.

  • 18 rows of guarded builtins name no stand-in (the review counted them by reading each builtin's guard in src/; the list is to be derived again, by a command, in the fix).
  • A bool argument is not covered by the stand-in at all: it raises the general bool message in both modes. No stand-in row says so; secure_equals, split and f64_to_bytes reproduce it.

docs/PERFORMANCE.md.

  • Line 19 gives the --vs threshold and does not say that the local file mode's threshold is 5%.
  • Line 228: "more than 0.5% ... on all ten" reads as "on all ten at once"; the gate fails on any one.
  • Line 244: "Three of the other ten".

.github/workflows/codspeed.yml. Comments speak of "five Ir-gate workloads"; the gate measures every bench/*.eigs (ten).

Done when

  • A command over src/ lists every builtin whose argument guard has a lenient stand-in, with the stand-in; each of them has a row in docs/BUILTINS.md that names it, and the command and its output are in the PR.
  • The file states once, where it explains the stand-ins, what a bool argument does in both modes, with one runnable example; or each stand-in row says it.
  • The three sentences of docs/PERFORMANCE.md and the comments of codspeed.yml say what the tree does, each number derived by a command shown in the PR.
  • bash tools/docs_claims_check.sh passes.

— 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 摘要。