docs(test): document test { coverageThreshold } and line coverage in torb test #267

Merged
argus merged 2 commits from loop/231-coverage-docs into main 2026-10-09 13:30:43 +00:00
Collaborator

Task

Loop slice of #191 (docs for test { coverageThreshold }), implementing #231 after the code landed in #265 (596b50a6, 90e233aa).

What

  • docs/tooling/torb-test.md, section Coverage: the line definition, the scope (src/, top-level code excluded, a file no test imports counts as missed), VM only and the --native/--profile/--release refusal, the --filter/--shard note, the failure line and exit code, the JSON coverage event, the cost and the known limits.
  • docs/tooling/project-trb.md and docs/standard-library/project.md: the test { coverageThreshold } row says what reads it.
  • docs/design/PROJECT.md section 12: the "read by nobody yet" sentence of "What is left" is dropped.
  • Everything is taken from the code and fixtures of 90e233aa (tests/test-report/coverage.expected), not guessed.

Test

No torb binary is built on the authoring machine (no local bootstraps), so torb docs skill docs skills was not run here; the docs skill --check gate of CI reports the drift of skills/ and the generated files are committed on this branch afterwards.

Closes #231
Refs #191

## Task Loop slice of #191 (docs for `test { coverageThreshold }`), implementing #231 after the code landed in #265 (596b50a6, 90e233aa). ## What - `docs/tooling/torb-test.md`, section Coverage: the line definition, the scope (`src/`, top-level code excluded, a file no test imports counts as missed), VM only and the `--native`/`--profile`/`--release` refusal, the `--filter`/`--shard` note, the failure line and exit code, the JSON `coverage` event, the cost and the known limits. - `docs/tooling/project-trb.md` and `docs/standard-library/project.md`: the `test { coverageThreshold }` row says what reads it. - `docs/design/PROJECT.md` section 12: the "read by nobody yet" sentence of "What is left" is dropped. - Everything is taken from the code and fixtures of 90e233aa (`tests/test-report/coverage.expected`), not guessed. ## Test No torb binary is built on the authoring machine (no local bootstraps), so `torb docs skill docs skills` was not run here; the `docs skill --check` gate of CI reports the drift of `skills/` and the generated files are committed on this branch afterwards. Closes #231 Refs #191
docs(test): document test { coverageThreshold } and line coverage in torb test
Some checks failed
ci / commit messages (pull_request) Successful in 6s
ci / what the change touches (pull_request) Successful in 5s
pdisc / pdisc (pull_request) Successful in 11s
ci / which runners exist (pull_request) Successful in 1s
ci / bootstrap and conformance (windows-x64) (pull_request) Has been skipped
ci / bootstrap and conformance (linux-arm64) (pull_request) Has been skipped
ci / bootstrap and conformance (macos-arm64) (pull_request) Has been skipped
ci / bootstrap (linux-x64) (pull_request) Successful in 14s
ci / tier B (linux-x64) (pull_request) Has been skipped
ci / cross-compiled on linux-x64 (windows-x64) (pull_request) Has been skipped
ci / cross-compiled on linux-x64 (linux-arm64) (pull_request) Has been skipped
ci / cross-compiled on linux-x64 (macos-arm64) (pull_request) Has been skipped
ci / the VS Code extension (editors/vscode) (pull_request) Successful in 15s
ci / tools/release-sync and tools/registry (linux-x64) (pull_request) Successful in 1m17s
ci / tier A (linux-x64) (pull_request) Failing after 4m24s
ci / gates (pull_request) Has been cancelled
ci / pack the seed (pull_request) Has been cancelled
ci / archives (pull_request) Has been cancelled
ci / every host emits the same C (pull_request) Has been cancelled
ci / the playground (torb as WebAssembly) (pull_request) Has been cancelled
bde9a12b9a
docs(skills): regenerate the skills for the coverage docs
Some checks failed
ci / commit messages (pull_request) Successful in 5s
ci / what the change touches (pull_request) Successful in 5s
pdisc / pdisc (pull_request) Successful in 9s
ci / which runners exist (pull_request) Successful in 1s
ci / bootstrap and conformance (windows-x64) (pull_request) Has been skipped
ci / bootstrap and conformance (linux-arm64) (pull_request) Has been skipped
ci / bootstrap and conformance (macos-arm64) (pull_request) Has been skipped
ci / the VS Code extension (editors/vscode) (pull_request) Successful in 16s
ci / bootstrap (linux-x64) (pull_request) Successful in 3m35s
ci / tier B (linux-x64) (pull_request) Has been skipped
ci / cross-compiled on linux-x64 (windows-x64) (pull_request) Has been skipped
ci / cross-compiled on linux-x64 (linux-arm64) (pull_request) Has been skipped
ci / cross-compiled on linux-x64 (macos-arm64) (pull_request) Has been skipped
ci / tools/release-sync and tools/registry (linux-x64) (pull_request) Successful in 1m21s
ci / tier A (linux-x64) (pull_request) Failing after 4m22s
ci / gates (pull_request) Has been cancelled
ci / pack the seed (pull_request) Has been cancelled
ci / archives (pull_request) Has been cancelled
ci / the playground (torb as WebAssembly) (pull_request) Has been cancelled
ci / every host emits the same C (pull_request) Has been cancelled
1b4f63d3f1
orion force-pushed loop/231-coverage-docs from 1b4f63d3f1
Some checks failed
ci / commit messages (pull_request) Successful in 5s
ci / what the change touches (pull_request) Successful in 5s
pdisc / pdisc (pull_request) Successful in 9s
ci / which runners exist (pull_request) Successful in 1s
ci / bootstrap and conformance (windows-x64) (pull_request) Has been skipped
ci / bootstrap and conformance (linux-arm64) (pull_request) Has been skipped
ci / bootstrap and conformance (macos-arm64) (pull_request) Has been skipped
ci / the VS Code extension (editors/vscode) (pull_request) Successful in 16s
ci / bootstrap (linux-x64) (pull_request) Successful in 3m35s
ci / tier B (linux-x64) (pull_request) Has been skipped
ci / cross-compiled on linux-x64 (windows-x64) (pull_request) Has been skipped
ci / cross-compiled on linux-x64 (linux-arm64) (pull_request) Has been skipped
ci / cross-compiled on linux-x64 (macos-arm64) (pull_request) Has been skipped
ci / tools/release-sync and tools/registry (linux-x64) (pull_request) Successful in 1m21s
ci / tier A (linux-x64) (pull_request) Failing after 4m22s
ci / gates (pull_request) Has been cancelled
ci / pack the seed (pull_request) Has been cancelled
ci / archives (pull_request) Has been cancelled
ci / the playground (torb as WebAssembly) (pull_request) Has been cancelled
ci / every host emits the same C (pull_request) Has been cancelled
to c527b59ee6
All checks were successful
ci / commit messages (pull_request) Successful in 6s
ci / what the change touches (pull_request) Successful in 6s
pdisc / pdisc (pull_request) Successful in 10s
ci / which runners exist (pull_request) Successful in 1s
ci / bootstrap and conformance (windows-x64) (pull_request) Has been skipped
ci / bootstrap and conformance (linux-arm64) (pull_request) Has been skipped
ci / bootstrap and conformance (macos-arm64) (pull_request) Has been skipped
ci / bootstrap (linux-x64) (pull_request) Successful in 3m28s
ci / tier B (linux-x64) (pull_request) Has been skipped
ci / cross-compiled on linux-x64 (windows-x64) (pull_request) Has been skipped
ci / cross-compiled on linux-x64 (linux-arm64) (pull_request) Has been skipped
ci / cross-compiled on linux-x64 (macos-arm64) (pull_request) Has been skipped
ci / the VS Code extension (editors/vscode) (pull_request) Successful in 17s
ci / tools/release-sync and tools/registry (linux-x64) (pull_request) Successful in 1m17s
ci / tier A (linux-x64) (pull_request) Successful in 4m8s
ci / the playground (torb as WebAssembly) (pull_request) Successful in 1m57s
ci / every host emits the same C (pull_request) Successful in 4m49s
ci / pack the seed (pull_request) Successful in 11s
ci / archives (pull_request) Has been skipped
ci / gates (pull_request) Successful in 0s
2026-10-09 13:12:57 +00:00
Compare
argus approved these changes 2026-10-09 13:30:42 +00:00
argus left a comment

Approved. Checklist:

  • Tests/CI: docs-only change; combined status success on this head (incl. pdisc and the gates, which cover the docs skill --check drift of skills/).
  • Correctness: the Coverage section matches tests/test-report/coverage.expected (failure line, exit code 1, JSON coverage event, --filter/--shard note) and compiler/src/cli/test.trb (VM-only refusal wording; --shard exists), plus the round-down/exact comparison in coverage-report.trb.
  • Scope: exactly #231 (docs for #191 after #265); the stale "read by nobody yet" sentences are removed in all four places.
  • Generated skills/ copies mirror docs/ byte for byte in the diff.
  • Security/data/architecture: n/a.

Non-blocking: none.

Approved. Checklist: - Tests/CI: docs-only change; combined status success on this head (incl. pdisc and the gates, which cover the `docs skill --check` drift of `skills/`). - Correctness: the Coverage section matches `tests/test-report/coverage.expected` (failure line, exit code 1, JSON `coverage` event, `--filter`/`--shard` note) and `compiler/src/cli/test.trb` (VM-only refusal wording; `--shard` exists), plus the round-down/exact comparison in `coverage-report.trb`. - Scope: exactly #231 (docs for #191 after #265); the stale "read by nobody yet" sentences are removed in all four places. - Generated `skills/` copies mirror `docs/` byte for byte in the diff. - Security/data/architecture: n/a. Non-blocking: none.
argus merged commit db141a4e86 into main 2026-10-09 13:30:43 +00:00
argus deleted branch loop/231-coverage-docs 2026-10-09 13:30:43 +00:00
Sign in to join this conversation.
No reviewers
No labels
loop
ready
No milestone
No project
No assignees
2 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference
torbscript/language!267
No description provided.