docs gate: the guard-state check reads a sentence across a Markdown block boundary and refuses a correct paragraph
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 83/100
- Issue type
- Bug
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- bash, c, markdown
- Domain
- documentation, testing-qa, tooling
Research direction
Start with tools/docs_claims_check.sh and its self-test cases, then inspect how the guard-state check separates Markdown prose blocks and sentences. Run bash tools/docs_claims_check.sh on a built tree with the example paragraph in docs/BUILTINS.md; done means it passes there while wrong-typed-argument claims remain red in both a paragraph and a table cell.
Written by the indexing model from the issue text.
Description
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
- Dominant language
- C
- Stars
- 3
- Forks
- 7
- Avg merge
- 3h 28m
- Merged PRs (30d)
- 270
Getting set up
Starts the project's dev container in your browser, under your own GitHub account.
- Ships a Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from InauguralSystems/EigenScript
-
area:gates needs-triage
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
InauguralSystems/EigenScript#2462 · 1 comment ·
Maintainers usually reply within 1 day
-
The hosted-RNG check refuses a clean tree that has a tracked file with a double quote in its nameOpenarea:gates kind:gate-defect needs-triage
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
InauguralSystems/EigenScript#2461 · 1 comment ·
Maintainers usually reply within 1 day
-
area:gates kind:gate-defect needs-triage
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
InauguralSystems/EigenScript#2458 · 1 comment ·
Maintainers usually reply within 1 day
-
`http_post`: `headers` text with something after its JSON value now means no headers, without a wordOpenarea:http kind:silent-wrong
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
InauguralSystems/EigenScript#2394 · 1 comment ·
Maintainers usually reply within 1 day
-
area:docs good first issue kind:docs-drift
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
InauguralSystems/EigenScript#2360 ·
Maintainers usually reply within 1 day
All issues in InauguralSystems/EigenScript
Similar issues
-
Difficulty 1/5 Under an hour Newbie friendliness 92/100
flipperdevices/flipperzero-firmware#4520 ·
Maintainers usually reply within 1 day
-
area/build-framework kind/enhancement priority/low
Difficulty 2/5 1-3 hours Newbie friendliness 77/100
yugabyte/yugabyte-db#38826 ·
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 88/100
meshcore-dev/MeshCore#3891 · 1 comment ·
Maintainers usually reply within 1 day
-
bug grammar sev-3
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
-
BUG/MEDIUM: regex: worker SIGSEGV when a regex is applied to an empty body on libc-regex buildsOpenstatus: needs-triage type: bug
Difficulty 2/5 1-3 hours Newbie friendliness 75/100