Skip to content

Apply corrections from the said-preview review (tlon-apps#6156) - #3

Open
arthyn wants to merge 6 commits into
masterfrom
corrections-from-said-preview-review
Open

Apply corrections from the said-preview review (tlon-apps#6156)#3
arthyn wants to merge 6 commits into
masterfrom
corrections-from-said-preview-review

Conversation

@arthyn

@arthyn arthyn commented Jul 24, 2026

Copy link
Copy Markdown
Member

Captures the style and semantics corrections from @mikolajpp's and @Fang-'s review of tloncorp/tlon-apps#6156 so future generated code imitates the right things:

patterns.md

  • Comment Discipline: lowercase comments, flag-comment form for code segments (block above, closed with a bare ::), and a prohibition on tutorial-style / self-explanatory comments — with the exact before/after from the review.
  • New "Test Conventions (/lib/test-agent)" section: spell bind:m at each monadic step (no =* aliasing), +do-as for temporary src.bowl, bare-argument gate calls over literal cells.
  • Error Handling: new "One Meaning per Error Response" — semantic answers (%denied etc.) mean exactly one condition; genuine failures get a generic error channel; don't crash the host for semantically clear errors.
  • New pitfall: +rear/+snip mull failure when called on ?~-narrowed lests, with the head/tail-walk alternative.

architecture.md

  • Documentation Style: terse $name: purpose first line, .field/$type references, no padding.
  • Mark System: version suffixes track wire revisions — new marks start unversioned, and suffixes pair with the path version that speaks them.
  • Subscriptions: gall expels the wex entry in the same event it processes %leave (and nonces wires internally) — no lingering-subscription workarounds.

🤖 Generated with Claude Code

arthyn and others added 3 commits July 24, 2026 10:24
From mikolajpp's and Fang-'s review:

- comment discipline: lowercase comments, flag-comment form for code
  segments, no tutorial-style/self-explanatory comments (hoon or shell)
- documentation style: terse `$name: purpose` first line, .field/$type
  references, no padding
- error handling: one meaning per semantic error response; generic
  error channel for genuine failures; don't crash the host for
  semantically clear errors
- test conventions: spell bind:m (no =* aliasing), +do-as for
  temporary src, bare-argument gate calls
- pitfall: +rear/+snip mull-fail on ?~-narrowed lests
- marks: version suffixes track wire revisions — new marks start
  unversioned, suffix pairs with path version
- gall: %leave expels the wex entry in the same event; no lingering
  subscription to work around

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@arthyn
arthyn requested review from Fang- and mikolajpp July 29, 2026 14:44
Comment thread patterns.md Outdated
Comment thread patterns.md Outdated
Comment thread patterns.md Outdated
Comment thread patterns.md Outdated
Comment thread patterns.md Outdated
Comment thread architecture.md Outdated
Comment thread architecture.md Outdated
arthyn and others added 3 commits July 31, 2026 14:47
Co-authored-by: fang <github@fang.io>
Co-authored-by: fang <github@fang.io>
Fang's review of the said-preview corrections flagged several rules as
over-generalized from one PR's context:

- Drop the /v0/said endpoint mention from the comment-style example;
  endpoints don't belong in type docs.
- Delete the %watch-ack bad/good pair under One Meaning per Error
  Response — the two snippets were near-identical, so the prose carries
  it alone.
- Scope the "don't crash for a semantically clear error" corollary to
  interfaces that already answer in responses. Rejecting a subscription
  on permissions by crashing stays correct.
- Move the bare-argument/auto-cons rule out of Test Conventions into
  Common Idioms next to Same-Subject Cell Collapse, and note that the
  splice only reaches the trailing element.
- Soften the mark-suffix/path-version pairing and replace the false
  example: channels serves %channels on both /x/v0 and /x/v1, and
  /x/v3/heads gives %channel-heads-2.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@arthyn
arthyn requested a review from Fang- July 31, 2026 20:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants