docs gate: the opt-in wording checks stop one of the six sentences that the #2439 documents removed

Offen
#2,454 2 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 1 Tag

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Anfängerfreundlichkeit
72/100
Issue-Typ
Bug
Klarheit
Klar beschrieben
Aktivitätsstatus
Aktiv
Tech-Stack
c, shell

Rechercherichtung

Start with tools/docs_claims_check.sh and inspect the documents' change in #2439 to retrieve the six sentences and their source files. Extend the self-test to plant each sentence, report how many it examined, and confirm each is rejected with a diagnostic naming its file; run the gate on the current documents as the clean control. Done means all six are caught regardless of line wrapping, while the header states the two patterns it checks and that rewordings can pass.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

area:gates kind:gate-defect

tools/docs_claims_check.sh has two checks for wording that says argument guards are opt-in (added with the documents of #2439: its self-test cases stale-strict-opt-in and stale-guard-state). An independent review of that change put back, one at a time, each of the six opt-in sentences the change removes, and ran the gate:

  • red: the sentence of docs/SYNTAX.md (says EIGS_STRICT=1 opts into invalid-argument errors; unset already enables guards);
  • green: the sentences of README.md, docs/llms.txt, docs/LANGUAGE_CONTRACT.md, docs/COMPARISON.md and the box of docs/BUILTINS.md.

Why: the first check matches one spelling on one line (the same sentence wrapped over two lines, as docs/LANGUAGE_CONTRACT.md had it, does not match), and the second needs "raises" or "rejects" near "under EIGS_STRICT=1" or "in strict mode", which the removed sentences do not have. Close rewordings pass too ("...raises only when EIGS_STRICT=1 is set", "Argument guards are opt-in: ...").

So a merge or an old branch that brings one of those sentences back is not stopped by the gate. The two self-test cases do go red on what they plant; the gap is what they do not plant.

Done when

  • The six sentences that the documents' change of #2439 removed (take them from that change's diff, by a command) are each refused when put back into the file they came from, by a line that names the file; matching ignores how the sentence is wrapped. The self-test plants all six and prints how many it examined.
  • The check says in its header what it holds (those six sentences, and the two patterns) and that it is not a reader of meaning: a reworded opt-in sentence passes. No sentence of the header claims more.
  • The clean control: the documents as they are pass.

— 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.