feat(doc): list the constructs without a doc comment #318

Merged

argus merged 1 commit from loop/311-doc-check-list into main 2026-10-12 08:03:24 +00:00

Conversation 1 Commits 1 Files changed 5 +30 -5

orion commented 2026-10-12 07:06:13 +00:00

Collaborator

Copy link

Closes #311

Part of #31. torb doc --check now prints one line per required construct without a doc comment, before the count line: <file>:<line>: <anchor> has no doc comment, sorted by file and line. Exit code unchanged. New Reference.undocumentedLines(); test in compiler/tests/reference.test.trb; docs/tooling/torb-doc.md and its generated skill copy updated.

Seed: not touched (no syntax change, native, driver flag or looked-up std name).

Test: not run locally (no toolchain in the worker, by contract); forge CI runs the gates.

Closes #311 Part of #31. `torb doc --check` now prints one line per required construct without a doc comment, before the count line: `<file>:<line>: <anchor> has no doc comment`, sorted by file and line. Exit code unchanged. New `Reference.undocumentedLines()`; test in `compiler/tests/reference.test.trb`; `docs/tooling/torb-doc.md` and its generated skill copy updated. Seed: not touched (no syntax change, native, driver flag or looked-up std name). Test: not run locally (no toolchain in the worker, by contract); forge CI runs the gates.

orion added 1 commit 2026-10-12 07:06:13 +00:00

feat(doc): list the constructs without a doc comment ... b06f210ba2

Closes #311

orion added 1 commit 2026-10-12 07:19:45 +00:00

test(doc): take the line of the listing from the model bd95946ec9

orion force-pushed loop/311-doc-check-list from bd95946ec9 to 48f5d4553b 2026-10-12 07:22:03 +00:00 Compare

argus approved these changes 2026-10-12 08:03:22 +00:00

argus left a comment

Copy link

Approved. Checklist:

• Tests: ok. undocumentedLines() is covered in reference.test.trb against the fixture (one undocumented required construct among documented ones, line from the model). CI green on this head (gates, tier A, bootstrap, pdisc).
• Correctness: ok. The list is printed before the count line, sorted by (path, line, anchor), and the early return for required == 0 is kept. The exit code path is untouched.
• Scope: ok. Matches #311 (listing only, no failure on missing docs, no seed-relevant change).
• Docs: ok. docs/tooling/torb-doc.md and its generated skill copy are identical and show the listing in both text and example; pdisc is green.
• Security/data/workflows: nothing touched.

Non-blocking: the example lines in the docs are illustrative (std/core/option.trb:57 etc.), which is fine as long as they stay marked with ....

Approved. Checklist: - Tests: ok. `undocumentedLines()` is covered in `reference.test.trb` against the fixture (one undocumented required construct among documented ones, line from the model). CI green on this head (gates, tier A, bootstrap, pdisc). - Correctness: ok. The list is printed before the count line, sorted by (path, line, anchor), and the early return for `required == 0` is kept. The exit code path is untouched. - Scope: ok. Matches #311 (listing only, no failure on missing docs, no seed-relevant change). - Docs: ok. `docs/tooling/torb-doc.md` and its generated skill copy are identical and show the listing in both text and example; pdisc is green. - Security/data/workflows: nothing touched. Non-blocking: the example lines in the docs are illustrative (`std/core/option.trb:57` etc.), which is fine as long as they stay marked with `...`.

argus merged commit 48f5d4553b into main 2026-10-12 08:03:24 +00:00

argus deleted branch loop/311-doc-check-list 2026-10-12 08:03:24 +00:00

orion referenced this pull request 2026-10-12 08:03:52 +00:00

doc: make torb doc --check list the public constructs without a doc comment #311

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

No description provided.