doc: document the 218 public constructs and make torb doc --check fail #31
Loading…
Reference in a new issue
No description provided.
Delete branch "%!s()"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Context
std/has 218 public constructs without a doc comment;torb doc --checkcounts them and does not fail.Source
torb docAcceptance criteria
std/has a doc commenttorb doc --checkfails on a missing oneDependencies
None known.
Moved from the planning lists of the docs; the design record stays the specification.
[loop:torbscript] intake: in scope (author orion, label loop). Docs work across
std/(218 constructs) plus a failingtorb doc --checkand a gate. Large; to be split per std module in refine, sonnet/medium workers. Docs regenerateskills/. No collision with CONCEPT "Open Questions". Release freeze for 0.1.0 (2026-10-06) holds new PRs, next: refine (queued)## Declarationssections of the standard library pages #32[loop:torbscript] refine: still queued behind the intake order. next: waiting (ready buffer full: #4, #163, #164, #223 are ready) until 2026-10-10T04:00:00Z
[loop:torbscript] claim refine by session:loop-torbscript-20261012 until 2026-10-12T09:01Z
torb doc --checklist the public constructs without a doc comment #311torb doc --checkfail on a public construct without a doc comment #317[loop:torbscript] decided by the loop: this issue is the umbrella and is split into one PR each, because 218 constructs over ~45 modules plus a compiler change is far more than one PR. Slices: #311 (
--checklists the missing constructs, no behaviour change; needed so workers have the exact list), #312 to #316 (doc comments for disjoint module groups ofstd/, independent of each other, sonnet/medium), #317 (flip--checkto fail; blocked by all of them; the existing tier A gatedoc --check --no-run stdthen enforces it, so no new gate). Count onmain(a95cb5c): the docs and the issue say 218 of 2353; a source scan (public declaration with no doc comment above it) finds ~197 at declaration level (the rest are members and fields), the biggest are prelude 39, core 16, os 15, encoding 13, geometry 11; the exact list comes from #311. Seed impact: none for any slice (comments and the doc tool only). This issue stays open as the umbrella and is closed when #317 lands; it is not labelledreadyitself.[loop:torbscript] refine: split into #311 to #317 (definition of ready met for each; first slice #311 labelled
ready, the others follow as the ready buffer allows), next: implement #311. Tokens: ~90k (RE worker, sonnet).[loop:torbscript] close: all slices (#311 to #317) are closed; the last landed as
41b6874e60with main CI green, so every public construct of std/ is documented andtorb doc --checkfails on a missing one. Issue closed, next: done