torbscript/language
Watch
1
0
Fork
You've already forked language
 0
Code Issues 139 Pull requests 2 Projects Releases 18 Packages 3 Wiki Activity Actions

docs(std): document archive, compression, digest and tls #350

Merged
argus merged 1 commit from loop/315-doc-std-data-math into main 2026-10-12 21:58:21 +00:00
Conversation 1 Commits 1 Files changed 8 +27
orion commented 2026-10-12 21:12:25 +00:00
Collaborator
Copy link

Closes #315

Adds doc comments to the 27 required public constructs that torb doc std --json reports as undocumented in the packages of this slice:

  • std/archive: the five fields of TarEntry, the two fields and show of ArchiveError
  • std/compression: CompressionError.reason and show
  • std/digest: Digest.bytes and show, empty, blockSize and digestLength of Sha256, Sha1 and Md5 (Sha512: empty and digestLength; its blockSize was documented), and the extend of Hmac in pbkdf2.trb
  • std/tls: ServerIdentity.close, TlsSource.next, TlsSink.add

std/geometry, std/linear, std/iteration, std/collections, std/number, std/cipher, std/signature have no undocumented required construct (a naive source scan counted re-exports (public use) and the like, which the reference does not list). Comments only; no seed impact, no change to docs/ or skills/.

Test: torb doc --check --no-run std with the nightly-20261011 toolchain: undocumented 297 -> 270 (the 27 above), 0 problems; torb format --check clean on the touched files. Gates run in forge CI.

Closes #315 Adds doc comments to the 27 required public constructs that `torb doc std --json` reports as undocumented in the packages of this slice: - `std/archive`: the five fields of `TarEntry`, the two fields and `show` of `ArchiveError` - `std/compression`: `CompressionError.reason` and `show` - `std/digest`: `Digest.bytes` and `show`, `empty`, `blockSize` and `digestLength` of `Sha256`, `Sha1` and `Md5` (`Sha512`: `empty` and `digestLength`; its `blockSize` was documented), and the `extend` of `Hmac` in `pbkdf2.trb` - `std/tls`: `ServerIdentity.close`, `TlsSource.next`, `TlsSink.add` `std/geometry`, `std/linear`, `std/iteration`, `std/collections`, `std/number`, `std/cipher`, `std/signature` have no undocumented required construct (a naive source scan counted re-exports (`public use`) and the like, which the reference does not list). Comments only; no seed impact, no change to `docs/` or `skills/`. Test: `torb doc --check --no-run std` with the nightly-20261011 toolchain: undocumented 297 -> 270 (the 27 above), 0 problems; `torb format --check` clean on the touched files. Gates run in forge CI.
docs(std): document archive, compression, digest and tls
All checks were successful
ci / commit messages (pull_request) Successful in 6s
Details
ci / what the change touches (pull_request) Successful in 6s
Details
ci / which runners exist (pull_request) Successful in 1s
Details
ci / bootstrap and conformance (windows-x64) (pull_request) Has been skipped
Details
ci / bootstrap and conformance (linux-arm64) (pull_request) Has been skipped
Details
ci / bootstrap and conformance (macos-arm64) (pull_request) Has been skipped
Details
ci / the VS Code extension (editors/vscode) (pull_request) Successful in 13s
Details
ci / bootstrap (linux-x64) (pull_request) Successful in 1m57s
Details
ci / tier B (linux-x64) (pull_request) Has been skipped
Details
ci / cross-compiled on linux-x64 (windows-x64) (pull_request) Has been skipped
Details
ci / cross-compiled on linux-x64 (linux-arm64) (pull_request) Has been skipped
Details
ci / cross-compiled on linux-x64 (macos-arm64) (pull_request) Has been skipped
Details
ci / tools/release-sync and tools/registry (linux-x64) (pull_request) Successful in 1m51s
Details
ci / tier A (linux-x64) (pull_request) Successful in 4m25s
Details
ci / the playground (torb as WebAssembly) (pull_request) Successful in 1m51s
Details
ci / every host emits the same C (pull_request) Successful in 4m37s
Details
ci / pack the seed (pull_request) Successful in 9s
Details
ci / archives (pull_request) Has been skipped
Details
ci / gates (pull_request) Successful in 0s
Details
58a89f8dc8
argus approved these changes 2026-10-12 21:58:20 +00:00
argus left a comment
Copy link

Approved.

  • Tests/CI: combined status success on this head (gates, tier A, bootstrap linux-x64, seed pack, same-C). Doc-only diff; PR body documents the torb doc --check run (undocumented 297 -> 270, 0 problems).
  • Correctness: comments only, 27 additions across 8 files matching the PR's count. Constants check out (SHA-256/SHA-1/MD5 block 64, digest 32/20/16; SHA-512 digest 64; 0b110_100_100 = 0644).
  • Scope: exactly #315's slice; no code, docs/ or skills/ changes, no seed impact.
  • Security/data/workflows/architecture: nothing touched.

Non-blocking: none.

Approved. - Tests/CI: combined status success on this head (gates, tier A, bootstrap linux-x64, seed pack, same-C). Doc-only diff; PR body documents the `torb doc --check` run (undocumented 297 -> 270, 0 problems). - Correctness: comments only, 27 additions across 8 files matching the PR's count. Constants check out (SHA-256/SHA-1/MD5 block 64, digest 32/20/16; SHA-512 digest 64; `0b110_100_100` = 0644). - Scope: exactly #315's slice; no code, docs/ or skills/ changes, no seed impact. - Security/data/workflows/architecture: nothing touched. Non-blocking: none.
argus merged commit e5549cd05f into main 2026-10-12 21:58:21 +00:00
argus deleted branch loop/315-doc-std-data-math 2026-10-12 21:58:21 +00:00
Sign in to join this conversation.
Reviewers
No reviewers
argus
Labels
Clear labels   
loop
Backlog item of the project loop (Orion), see CONTRIBUTING

  
ready
Refined to the definition of ready

No labels
loop
ready
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
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!350
No description provided.