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

Ouverte
#2,409 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Les mainteneurs répondent en général sous 1 jour

Personne n'a encore pris cette issue.

Évaluation

Difficulté
3/5
Temps estimé
1-2 jours
Accessibilité débutants
58/100
Type d'issue
Documentation
Clarté
Clairement spécifiée
Activité
Active
Stack technique
bash, c
Domaine
documentation

Piste de recherche

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.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

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

Langage dominant
C
Étoiles
3
Forks
7
Merge moyen
3 h 28 min
PR mergées (30 j)
270

Préparer son environnement

Ouvrir dans Codespaces

Lance le conteneur de développement du projet dans votre navigateur, avec votre propre compte GitHub.

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de InauguralSystems/EigenScript

Toutes les issues de InauguralSystems/EigenScript

Issues similaires

Plus d'issues C

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.