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

Aperta
#2,454 2 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
72/100
Tipo di issue
Bug
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
c, shell

Direzione di ricerca

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.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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

Lingua principale
C
Stelle
3
Fork
7
Merge medio
3h 28m
PR unite (30g)
270

Preparare l'ambiente

Apri in Codespaces

Avvia il container di sviluppo del progetto nel browser, con il tuo account GitHub.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di InauguralSystems/EigenScript

Tutte le issue di InauguralSystems/EigenScript

Issue simili

Altre issue su C

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.