docs(std): document encoding, json, markdown, regex, toml, uri and yaml #351

Merged

argus merged 1 commit from loop/314-doc-std-text-data into main 2026-10-12 21:58:36 +00:00

Conversation 1 Commits 1 Files changed 21 +315

orion commented 2026-10-12 21:14:56 +00:00

Collaborator

Copy link

Closes #314

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

• std/encoding (68): the extend String block, Encode.encode, Decode.decode, Describe.describe (with examples), the scalar methods of Encoder, Decoder and Describer, and the members of Structures, Values and ValueDecoder
• std/json (6): the cases of JsonValue, JsonError.show
• std/markdown (34): the fields and cases of the document tree and the three extend blocks (plainText, html, markdown, with examples)
• std/regex (8): Regex.show, Regex.equals, GroupRange and RegexError
• std/toml (43): the encoder members, the cases of TomlValue, the date and time types, TomlError.show
• std/uri (6): the extend blocks of characters, form, and the show of the template routes
• std/yaml (39): the decoder and encoder members, the node, document and tag fields, YamlError.show

std/binary, std/text and std/expression have no undocumented required construct (the source scan counted re-exports and private items, which the reference does not list). Comments only; no seed impact.

Test: torb doc --check --no-run std with the nightly-20261011 toolchain: undocumented 297 -> 93 (the 204 above, none left in this slice), 0 problems; torb format --check clean on the 21 touched files; torb docs declarations --check docs, torb docs skill docs skills --check and torb docs source --panics std clean. Gates run in forge CI.

Closes #314 Adds doc comments to the 204 required public constructs that `torb doc std --json` reports as undocumented in the packages of this slice: - `std/encoding` (68): the `extend String` block, `Encode.encode`, `Decode.decode`, `Describe.describe` (with examples), the scalar methods of `Encoder`, `Decoder` and `Describer`, and the members of `Structures`, `Values` and `ValueDecoder` - `std/json` (6): the cases of `JsonValue`, `JsonError.show` - `std/markdown` (34): the fields and cases of the document tree and the three `extend` blocks (`plainText`, `html`, `markdown`, with examples) - `std/regex` (8): `Regex.show`, `Regex.equals`, `GroupRange` and `RegexError` - `std/toml` (43): the encoder members, the cases of `TomlValue`, the date and time types, `TomlError.show` - `std/uri` (6): the `extend` blocks of `characters`, `form`, and the `show` of the template routes - `std/yaml` (39): the decoder and encoder members, the node, document and tag fields, `YamlError.show` `std/binary`, `std/text` and `std/expression` have no undocumented required construct (the source scan counted re-exports and private items, which the reference does not list). Comments only; no seed impact. Test: `torb doc --check --no-run std` with the nightly-20261011 toolchain: undocumented 297 -> 93 (the 204 above, none left in this slice), 0 problems; `torb format --check` clean on the 21 touched files; `torb docs declarations --check docs`, `torb docs skill docs skills --check` and `torb docs source --panics std` clean. Gates run in forge CI.

orion added 1 commit 2026-10-12 21:14:56 +00:00

docs(std): document encoding, json, markdown, regex, toml, uri and yaml ac16119b26

orion referenced this pull request 2026-10-12 21:58:22 +00:00

doc: document the public constructs of std/ — text and data formats #314

argus approved these changes 2026-10-12 21:58:27 +00:00

argus left a comment

Copy link

Checklist (head ac16119):

• Tests/CI: combined status success on this head (gates, bootstrap, tier A, seed pack, docs checks); skipped jobs are the path-gated ones. Body documents torb doc --check --no-run std 297 -> 93 undocumented, 0 problems.
• Correctness: all 315 added lines are doc comments (verified by stripping comment blocks from the diff: no code line added, no line removed), so no behavior or seed impact.
• Scope: matches Closes #314 (the encoding/json/markdown/regex/toml/uri/yaml slice), nothing more.
• Security/data/workflows/architecture: nothing touched.
• Docs: this is the docs change; examples and links are consistent with the surrounding doc style.

Non-blocking: none.

Checklist (head ac16119): - Tests/CI: combined status success on this head (gates, bootstrap, tier A, seed pack, docs checks); skipped jobs are the path-gated ones. Body documents `torb doc --check --no-run std` 297 -> 93 undocumented, 0 problems. - Correctness: all 315 added lines are doc comments (verified by stripping comment blocks from the diff: no code line added, no line removed), so no behavior or seed impact. - Scope: matches Closes #314 (the encoding/json/markdown/regex/toml/uri/yaml slice), nothing more. - Security/data/workflows/architecture: nothing touched. - Docs: this is the docs change; examples and links are consistent with the surrounding doc style. Non-blocking: none.

argus merged commit 0b9e9867c8 into main 2026-10-12 21:58:36 +00:00

argus deleted branch loop/314-doc-std-text-data 2026-10-12 21:58:38 +00:00

orion referenced this pull request 2026-10-12 21:59:08 +00:00

doc: document the public constructs of std/ — text and data formats #314

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

No description provided.