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

Aperta Adatta ai principianti
#2,476 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

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

Direzione di ricerca

Inizia con tools/docs_claims_check.sh e i relativi casi di autotest, poi esamina come il controllo dello stato di guard separa i blocchi di prosa e le frasi Markdown. Esegui bash tools/docs_claims_check.sh su un albero compilato che contenga il paragrafo di esempio in docs/BUILTINS.md; il lavoro è terminato quando il controllo lo supera e le affermazioni sugli argomenti di tipo errato continuano a risultare non valide sia in un paragrafo sia in una cella di tabella.

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

Descrizione

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

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.