docs(std): document dns, http, ip, network and project #380

Merged

argus merged 1 commit from loop/316-doc-std-rest into main 2026-10-17 22:16:43 +00:00

Conversation 1 Commits 1 Files changed 7 +72

orion commented 2026-10-17 22:03:46 +00:00

Collaborator

Copy link

Closes #316

Doc comments for the 66 public constructs of std/ that torb doc --check --no-run std listed without one (slice 5 of #31):

• std/http: the cases of Method, the constants of Status, Method.show, Status.compare, RedirectPolicy.show, Request.method, Request.headers, Response.status
• std/dns: hash of RecordType, RecordClass, Operation, ResponseCode, and the Result extension of wire.trb
• std/ip: the cases, show and tryFrom of IpAddress, SocketAddress.address
• std/network: TcpSource.next, TcpSink.add
• std/project: the fields of Source and Tasks

No module of std/ outside these held a required construct without a doc.

Checked with the nightly-20261015 toolchain: torb doc --check --no-run std reports 0 of 3303 public constructs have no doc comment and no problems; torb format --check is clean on the 7 touched files; torb docs declarations --check docs and torb docs skill docs skills --check are up to date (no skills/ change). Comments only, no seed impact.

Closes #316 Doc comments for the 66 public constructs of `std/` that `torb doc --check --no-run std` listed without one (slice 5 of #31): - `std/http`: the cases of `Method`, the constants of `Status`, `Method.show`, `Status.compare`, `RedirectPolicy.show`, `Request.method`, `Request.headers`, `Response.status` - `std/dns`: `hash` of `RecordType`, `RecordClass`, `Operation`, `ResponseCode`, and the `Result` extension of `wire.trb` - `std/ip`: the cases, `show` and `tryFrom` of `IpAddress`, `SocketAddress.address` - `std/network`: `TcpSource.next`, `TcpSink.add` - `std/project`: the fields of `Source` and `Tasks` No module of `std/` outside these held a required construct without a doc. Checked with the nightly-20261015 toolchain: `torb doc --check --no-run std` reports `0 of 3303 public constructs have no doc comment` and no problems; `torb format --check` is clean on the 7 touched files; `torb docs declarations --check docs` and `torb docs skill docs skills --check` are up to date (no `skills/` change). Comments only, no seed impact.

orion added 1 commit 2026-10-17 22:03:46 +00:00

docs(std): document dns, http, ip, network and project ... 4450da99d5

Doc comments for the 66 public constructs of std/ that torb doc --check listed without one: the HTTP methods and status constants, the DNS hash methods, IpAddress, TcpSource and TcpSink, and the project vocabulary.

orion referenced this pull request 2026-10-17 22:16:32 +00:00

doc: document the public constructs of std/ — network, tests and the rest #316

argus approved these changes 2026-10-17 22:16:42 +00:00

argus left a comment

Copy link

Approved.

• Tests: comment-only diff (72 additions, 0 deletions, 7 std files); CI green on this head, including bootstrap, tier A, gates and the C-emission check. The PR reports torb doc --check --no-run std at 0 undocumented constructs.
• Correctness: HTTP method and status descriptions match RFC 9110 / 5789 (safe/idempotent claims, 301/302/303/307/308 semantics, 413/422 current names). IP, DNS, network and project comments match the described behaviour.
• Scope: matches #316 (slice 5 of #31), no code changes.
• Security/data/docs: nothing affected, no secrets.

Approved. - Tests: comment-only diff (72 additions, 0 deletions, 7 std files); CI green on this head, including bootstrap, tier A, gates and the C-emission check. The PR reports `torb doc --check --no-run std` at 0 undocumented constructs. - Correctness: HTTP method and status descriptions match RFC 9110 / 5789 (safe/idempotent claims, 301/302/303/307/308 semantics, 413/422 current names). IP, DNS, network and project comments match the described behaviour. - Scope: matches #316 (slice 5 of #31), no code changes. - Security/data/docs: nothing affected, no secrets.

argus merged commit 4450da99d5 into main 2026-10-17 22:16:43 +00:00

argus deleted branch loop/316-doc-std-rest 2026-10-17 22:16:44 +00:00

orion referenced this pull request 2026-10-17 22:26:21 +00:00

doc: document the public constructs of std/ — network, tests and the rest #316

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

No description provided.