docs gate: the guard-state check reads a sentence across a Markdown block boundary and refuses a correct paragraph
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ó
- 2/5
- Thời gian dự kiến
- 1-3 giờ
- Mức phù hợp với người mới
- 83/100
- Loại issue
- Lỗi
- Độ rõ ràng
- Đặc tả rõ ràng
- Mức độ hoạt động
- Sôi nổi
- Công nghệ
- bash, c, markdown
- Lĩnh vực
- documentation, testing-qa, tooling
Hướng nghiên cứu
Bắt đầu với tools/docs_claims_check.sh và các trường hợp tự kiểm thử của nó, sau đó xem cách kiểm tra trạng thái guard tách các khối văn xuôi và câu trong Markdown. Chạy bash tools/docs_claims_check.sh trên cây đã build có đoạn văn ví dụ trong docs/BUILTINS.md; hoàn thành khi kiểm tra chạy qua trong trường hợp đó và các khẳng định về đối số sai kiểu vẫn bị báo lỗi trong cả đoạn văn lẫn ô bảng.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
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
- 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
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.
- Có Dockerfile hoặc tệp Docker Compose
- Có mẫu pull request
- Đọc hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- 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.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Issue khác của InauguralSystems/EigenScript
-
area:gates needs-triage
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100
InauguralSystems/EigenScript#2462 · 1 bình luận ·
Maintainer thường phản hồi trong vòng 1 ngày
-
The hosted-RNG check refuses a clean tree that has a tracked file with a double quote in its nameĐang mởarea:gates kind:gate-defect needs-triage
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100
InauguralSystems/EigenScript#2461 · 1 bình luận ·
Maintainer thường phản hồi trong vòng 1 ngày
-
area:gates kind:gate-defect needs-triage
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 86/100
InauguralSystems/EigenScript#2458 · 1 bình luận ·
Maintainer thường phản hồi trong vòng 1 ngày
-
`http_post`: `headers` text with something after its JSON value now means no headers, without a wordĐang mởarea:http kind:silent-wrong
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 72/100
InauguralSystems/EigenScript#2394 · 1 bình luận ·
Maintainer thường phản hồi trong vòng 1 ngày
-
area:docs good first issue kind:docs-drift
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 70/100
InauguralSystems/EigenScript#2360 ·
Maintainer thường phản hồi trong vòng 1 ngày
Tất cả issue của InauguralSystems/EigenScript
Issue tương tự
-
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 92/100
flipperdevices/flipperzero-firmware#4520 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
area/build-framework kind/enhancement priority/low
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 77/100
yugabyte/yugabyte-db#38826 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 88/100
meshcore-dev/MeshCore#3891 · 1 bình luận ·
Maintainer thường phản hồi trong vòng 1 ngày
-
bug grammar sev-3
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 76/100
-
BUG/MEDIUM: regex: worker SIGSEGV when a regex is applied to an empty body on libc-regex buildsĐang mởstatus: needs-triage type: bug
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 75/100