docs: stand-in rows of BUILTINS.md (18 without one, bool arguments unstated) and three stale sentences on the bench gate

Aberta
#2,409 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
3/5
Tempo estimado
1-2 dias
Facilidade para iniciantes
58/100
Tipo de issue
Documentação
Clareza
Claramente especificada
Status de atividade
Ativa
Stack de tecnologia
bash, c
Domínio
documentation

Direção de pesquisa

Read docs/BUILTINS.md, docs/PERFORMANCE.md, .github/workflows/codspeed.yml, and the builtin guards under src/. Derive the guarded builtins and benchmark counts or thresholds with commands, include those commands and outputs in the PR, then update the named documentation and comments. Run bash tools/docs_claims_check.sh; done means it passes and every listed documentation claim matches the tree.

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

Descrição

area:docs found-by:critic kind:docs-drift

Found by the blind review of #2402 (two passes), beside that change's bar. Each was seen on main's text; none is new with #2402.

docs/BUILTINS.md, the rows of builtins with a lenient stand-in. The file says near its top that a row whose builtin answers with a stand-in under EIGS_STRICT=0 names that stand-in.

  • 18 rows of guarded builtins name no stand-in (the review counted them by reading each builtin's guard in src/; the list is to be derived again, by a command, in the fix).
  • A bool argument is not covered by the stand-in at all: it raises the general bool message in both modes. No stand-in row says so; secure_equals, split and f64_to_bytes reproduce it.

docs/PERFORMANCE.md.

  • Line 19 gives the --vs threshold and does not say that the local file mode's threshold is 5%.
  • Line 228: "more than 0.5% ... on all ten" reads as "on all ten at once"; the gate fails on any one.
  • Line 244: "Three of the other ten".

.github/workflows/codspeed.yml. Comments speak of "five Ir-gate workloads"; the gate measures every bench/*.eigs (ten).

Done when

  • A command over src/ lists every builtin whose argument guard has a lenient stand-in, with the stand-in; each of them has a row in docs/BUILTINS.md that names it, and the command and its output are in the PR.
  • The file states once, where it explains the stand-ins, what a bool argument does in both modes, with one runnable example; or each stand-in row says it.
  • The three sentences of docs/PERFORMANCE.md and the comments of codspeed.yml say what the tree does, each number derived by a command shown in the PR.
  • bash tools/docs_claims_check.sh passes.

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