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

Offen Anfängerfreundlich
#2,476 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 1 Tag

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Anfängerfreundlichkeit
83/100
Issue-Typ
Bug
Klarheit
Klar beschrieben
Aktivitätsstatus
Aktiv
Tech-Stack
bash, c, markdown

Rechercherichtung

Beginne mit tools/docs_claims_check.sh und seinen Selbsttestfällen. Untersuche dann, wie die Guard-State-Prüfung Markdown-Textblöcke und Sätze voneinander trennt. Führe bash tools/docs_claims_check.sh für einen gebauten Baum mit dem Beispielabsatz in docs/BUILTINS.md aus; fertig ist die Änderung, wenn die Prüfung dort besteht und Behauptungen zu Argumenten mit falschem Typ sowohl in einem Absatz als auch in einer Tabellenzelle weiterhin als Fehler erkannt werden.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

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

Vorherrschende Sprache
C
Sterne
3
Forks
7
Ø Merge
3 Std. 28 Min.
Gemergte PRs (30 T.)
270

Entwicklungsumgebung

In Codespaces öffnen

Startet den Dev-Container des Projekts im Browser, mit Ihrem eigenen GitHub-Konto.

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus InauguralSystems/EigenScript

Alle Issues in InauguralSystems/EigenScript

Ähnliche Issues

Weitere Issues zu C

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.