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

Aberta Para iniciantes
#2,476 0 comentários 0 reações 0 responsáveis Ver no GitHub

Mantenedores costumam responder em até 1 dia

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
2/5
Tempo estimado
1-3 horas
Facilidade para iniciantes
83/100
Tipo de issue
Bug
Clareza
Claramente especificada
Status de atividade
Ativa
Stack de tecnologia
bash, c, markdown

Direção de pesquisa

Comece por tools/docs_claims_check.sh e seus casos de autoteste; depois, examine como a verificação do estado de guard separa blocos de prosa e frases Markdown. Execute bash tools/docs_claims_check.sh em uma árvore compilada que contenha o parágrafo de exemplo em docs/BUILTINS.md; o trabalho estará concluído quando a verificação passar nesse caso e as alegações sobre argumentos de tipo incorreto continuarem falhando tanto em um parágrafo quanto em uma célula de tabela.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

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

Linguagem predominante
C
Estrelas
3
Forks
7
Merge médio
3h 28min
PRs com merge (30d)
270

Preparar o ambiente

Abrir no Codespaces

Inicia o contêiner de desenvolvimento do projeto no navegador, com a sua própria conta do GitHub.

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de InauguralSystems/EigenScript

Todas as issues de InauguralSystems/EigenScript

Issues semelhantes

Mais issues de C

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.