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

Đang mở
#2,409 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
3/5
Thời gian dự kiến
1-2 ngày
Mức phù hợp với người mới
58/100
Loại issue
Tài liệu
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
bash, c
Lĩnh vực
documentation

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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

Ngôn ngữ chính
C
Star
3
Fork
7
Merge trung bình
3 giờ 28 phút
Pull request đã merge (30 ngày)
270

Chuẩn bị môi trường

Mở trong Codespaces

Khởi chạy dev container của dự án ngay trên trình duyệt, bằng tài khoản GitHub của bạn.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của InauguralSystems/EigenScript

Tất cả issue của InauguralSystems/EigenScript

Issue tương tự

Thêm issue về C

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.