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

Offen
#2,409 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 1 Tag

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Anfängerfreundlichkeit
58/100
Issue-Typ
Dokumentation
Klarheit
Klar beschrieben
Aktivitätsstatus
Aktiv
Tech-Stack
bash, c
Bereich
documentation

Rechercherichtung

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.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

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

Vorherrschende Sprache
C
Sterne
3
Forks
7
Ø Merge
3 Std. 28 Min.
Gemergte PRs (30 T.)
270

Entwicklungsumgebung

In Codespaces öffnen

Startet den Dev-Container des Projekts im Browser, mit Ihrem eigenen GitHub-Konto.

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus InauguralSystems/EigenScript

Alle Issues in InauguralSystems/EigenScript

Ähnliche Issues

Weitere Issues zu C

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.