Skip to main content

Module comments

Module comments 

Source
Expand description

Anchored review comments: the person comments on a passage of a feature document, a line of the spec’s changes, a line of a shown visible test or a finding; the drafts collect in a tray in the state directory (<state>/comments/<unit>.json, never browser storage, never the worktree) and go out together as one revision turn of the format’s revising skill, scoped to the sections they touch. Before the turn the feature’s documents are snapshot; after it the change is shown per section, sections no comment touched flagged; Undo Revision restores the snapshot byte for byte, on the person’s command only (constitution 2.3.0, principle I). Code-view line comments become one nudge for a task’s next attempt.

Nothing here reads a held-out store: an anchor outside the feature’s documents, its changes, its shown tests and its findings is refused.

Structs§

FileDigest
A file’s digest before or after a turn.
Tray
The tray of one unit.
Turn
One revision turn as stored.

Constants§

DIR
The store’s directory under a project’s state directory.

Functions§

code_nudge
Send N Comments as a Nudge: Code-view line comments on a task’s diff as one note for its next attempt (path:line "quote" — text per line). A line of a frozen test is a review comment instead, never a nudge.
comment
Adds, deletes or keeps a comment (or keeps a revision turn, id tN), on the person’s command.
list
speccoder review comments: the tray and the last turn.
load
The tray of unit (empty when none was written).
revision_argument
The revising skill’s arguments: each comment with its quote and section, the sections touched, and that every other section stays as it is.
section_at
The heading path of line (1-based) in Markdown text: Requirements › Functional Requirements; empty before any heading.
sections
Each section of Markdown text by its heading path, with its body.
send
Send N Comments: one revision turn of the format’s revising skill, scoped to the sections the comments touch; test comments become one Ask Again per requirement after it (unless the revision lapsed that requirement’s tests). The drafts are consumed atomically: a second send of the same drafts is refused.
send_with
send against state, with provider for the skill and the author.
undo
Undo Revision, on the person’s command only: the documents back to the snapshot before the turn, byte for byte — refused when one changed since the turn (naming it); the comments return to the tray.