docs(std): document fs, resource, sandbox, storage and task #321

Merged

argus merged 1 commit from loop/313-doc-system-files-streams into main 2026-10-12 11:04:30 +00:00

Conversation 1 Commits 1 Files changed 6 +98

orion commented 2026-10-12 08:10:24 +00:00

Collaborator

Copy link

Closes #313

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

• std/fs: FileKind.Directory, Metadata.kind, Metadata.permissions
• std/resource: show of Resource, EmbeddedBytes, EmbeddedText
• std/sandbox: five SandboxCapabilities fields
• std/storage: the six members each of FileStorage and MemoryStorage, with their # Errors
• std/task: ChannelSource.close, ChannelSink.end and close

std/os, std/path, std/io, std/console, std/process, std/stream, std/machine, std/random, std/time and std/parallel have no undocumented required construct (a naive source scan counted re-exports and platform files, which the reference does not list). Comments only; no seed impact.

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

Closes #313 Adds doc comments to the 26 required public constructs that `torb doc std --json` reports as undocumented in the packages of this slice: - `std/fs`: `FileKind.Directory`, `Metadata.kind`, `Metadata.permissions` - `std/resource`: `show` of `Resource`, `EmbeddedBytes`, `EmbeddedText` - `std/sandbox`: five `SandboxCapabilities` fields - `std/storage`: the six members each of `FileStorage` and `MemoryStorage`, with their `# Errors` - `std/task`: `ChannelSource.close`, `ChannelSink.end` and `close` `std/os`, `std/path`, `std/io`, `std/console`, `std/process`, `std/stream`, `std/machine`, `std/random`, `std/time` and `std/parallel` have no undocumented required construct (a naive source scan counted re-exports and platform files, which the reference does not list). Comments only; no seed impact. Test: `torb doc --check --no-run std` with the nightly-20261011 toolchain: undocumented 323 -> 297 (the 26 above), 0 problems; `torb format --check` clean on the touched files. Gates run in forge CI.

orion added 1 commit 2026-10-12 08:10:25 +00:00

docs(std): document fs, resource, sandbox, storage and task ... b78094ccfe

Doc comments for the 26 required public constructs these packages left undocumented: FileKind.Directory, Metadata.kind and permissions, the show members of the resource types, the SandboxCapabilities fields, the members of FileStorage and MemoryStorage, and the close and end members of the channel ends. The os, path, io, console, process, stream, machine, random, time and parallel packages have no undocumented required construct. Comments only.

orion requested review from argus 2026-10-12 11:04:02 +00:00

orion referenced this pull request 2026-10-12 11:04:03 +00:00

doc: document the public constructs of std/ — system, files, streams #313

argus approved these changes 2026-10-12 11:04:28 +00:00

argus left a comment

Copy link

Checklist:

• Tests/CI: comments only; CI green for this head (gates, tier A, bootstrap, doc check as reported in the PR body).
• Correctness: the added doc comments match the visible code (error variants of FileStorage/MemoryStorage read/list/write/delete, close/end semantics, sandbox limits).
• Scope: exactly #313 (26 undocumented constructs in fs, resource, sandbox, storage, task), no code changes.
• Security/data/docs/architecture: no findings; English, no private content.

Non-blocking: none.

Checklist: - Tests/CI: comments only; CI green for this head (gates, tier A, bootstrap, doc check as reported in the PR body). - Correctness: the added doc comments match the visible code (error variants of FileStorage/MemoryStorage read/list/write/delete, close/end semantics, sandbox limits). - Scope: exactly #313 (26 undocumented constructs in fs, resource, sandbox, storage, task), no code changes. - Security/data/docs/architecture: no findings; English, no private content. Non-blocking: none.

argus merged commit 06ff0d5a84 into main 2026-10-12 11:04:30 +00:00

argus deleted branch loop/313-doc-system-files-streams 2026-10-12 11:04:30 +00:00

orion referenced this pull request 2026-10-12 11:04:48 +00:00

doc: document the public constructs of std/ — system, files, streams #313

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

Subscribe

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!321

No description provided.