docs(writing): sweep crate comments to house style #514

Merged

enricobuehler merged 31 commits from luxus/punktfunk:docs/comment-sweep into main 2026-09-02 00:18:26 +00:00

Conversation 0 Commits 31 Files Changed 579

+50564 -109650

luxus commented 2026-09-02 00:13:47 +00:00

Member

Copy Link

Copy Source

Comments in first-party crates were self-discussion: plan sections, review tickets, soaks, recap of the next five lines. House style keeps the live invariant.

This PR:

• Teaches comment voice in docs/writing.md (present tense, not archaeology, not a poem). Length CI stays a backstop.
• Adds /comment-sweep and /comment-sweep-all (one commit per crate; review_only after a crash).
• Rewrites comments crate by crate. // SAFETY: stays a proof. Vendor sys crates and **/vendor/** are out of scope.

Rebased onto current unom/main. Where main had landed real code (capture CCD keys, installer wizard), those hunks kept main.

User-facing fact changed? n/a.

Comments in first-party crates were self-discussion: plan sections, review tickets, soaks, recap of the next five lines. House style keeps the live invariant. This PR: - Teaches comment voice in `docs/writing.md` (present tense, not archaeology, not a poem). Length CI stays a backstop. - Adds `/comment-sweep` and `/comment-sweep-all` (one commit per crate; `review_only` after a crash). - Rewrites comments crate by crate. `// SAFETY:` stays a proof. Vendor sys crates and `**/vendor/**` are out of scope. Rebased onto current `unom/main`. Where main had landed real code (capture CCD keys, installer wizard), those hunks kept main. User-facing fact changed? n/a.

luxus added 30 commits 2026-09-02 00:14:58 +00:00

chore(writing): add crate comment-sweep workflow ... acef142655

House style caps comments, but the tree is still full of
plan-section novels. A per-crate sweep is the way through.
One run rewrites one crate, reviews every file, one commit.

docs(pf-paths): tighten comments to house style ... 3b06cbd584

Comments in this crate were self-discussion: plan sections, review
tickets, and recap of the next lines. House style keeps the trap and
the number.

chore(writing): add parallel all-crates comment sweep ... bc4acc6aaa

A session can only host four workflow runs, so one crate per
run cannot fan out. One run rewrites every crate in parallel
and still commits them one at a time.

docs(pf-gpu): tighten comments to house style ... bca0610d79

Comments in this crate were self-discussion: plan sections, review tickets,
and recap of the next lines. House style keeps the trap and the number.

docs(encode-worker): tighten comments to house style ... 07c4ffb2fe

Comments in this crate were self-discussion: plan sections, review
tickets, and recap of the next lines. House style keeps the trap and
the number.

docs(pf-update): tighten comments to house style ... 9e35f8e4b0

Comments in this crate were self-discussion: plan sections, review
tickets, and recap of the next lines. House style keeps the trap and
the number.

docs(pf-driver-proto): tighten comments to house style ... 1b0781b087

Comments in this crate were self-discussion: plan sections, review
tickets, and recap of the next lines. House style keeps the trap and
the number.

docs(writing): teach comment voice over line caps ... 0764b5a82e

Length CI catches novels. Models still write archaeology and poems
inside the cap. The rulebook has to show the present-tense invariant.

chore(writing): resume comment sweep from review ... 52f0492533

A crash killed the all-crates run after rewrite. review_only
skips the 402 batches and starts at coverage.

docs(pf-bitstream): tighten comments to house style ... 9a6710c052

Comments in this crate were self-discussion: plan sections, review
tickets, and recap of the next lines. House style keeps the trap and
the number.

docs(pf-capture): tighten comments to house style ... 98bcac7afd

Comments in this crate were self-discussion: plan sections, review
tickets, and recap of the next lines. House style keeps the trap and
the number.

docs(pf-client-core): tighten comments to house style ... 450c326c53

Comments in this crate were self-discussion: plan sections, review
tickets, and recap of the next lines. House style keeps the trap and
the number.

docs(pf-clipboard): tighten comments to house style ... 3729bd2071

Comments in this crate were self-discussion: plan sections, review
tickets, and recap of the next lines. House style keeps the trap and
the number.

docs(pf-console-ui): tighten comments to house style ... 44e5de85c4

Comments in this crate were self-discussion: plan sections, review
tickets, and recap of the next lines. House style keeps the trap and
the number.

docs(pf-dxvadec): tighten comments to house style ... 2792b7950d

Comments in this crate were self-discussion: plan sections, review
tickets, and recap of the next lines. House style keeps the trap and
the number.

docs(pf-encode): tighten comments to house style ... fc8e003b94

Comments in this crate were self-discussion: plan sections, review
tickets, and recap of the next lines. House style keeps the trap and
the number.

docs(pf-frame): tighten comments to house style ... 9adeb2ba5e

Comments in this crate were self-discussion: plan sections, review
tickets, and recap of the next lines. House style keeps the trap and
the number.

docs(pf-host-config): tighten comments to house style ... 25454ca42a

Comments in this crate were self-discussion: plan sections, review
tickets, and recap of the next lines. House style keeps the trap and
the number.

docs(pf-inject): tighten comments to house style ... 6bb79a57f7

Comments in this crate were self-discussion: plan sections, review
tickets, and recap of the next lines. House style keeps the trap and
the number.

docs(pf-presenter): tighten comments to house style ... 55b11f9004

Comments in this crate were self-discussion: plan sections, review
tickets, and recap of the next lines. House style keeps the trap and
the number.

docs(pf-update-check): tighten comments to house style ... 4b8d58b7db

Comments in this crate were self-discussion: plan sections, review
tickets, and recap of the next lines. House style keeps the trap and
the number.

docs(pf-vaadec): tighten comments to house style ... bc5213242a

Comments in this crate were self-discussion: plan sections, review
tickets, and recap of the next lines. House style keeps the trap and
the number.

docs(pf-vdisplay): tighten comments to house style ... d1e0afc752

Comments in this crate were self-discussion: plan sections, review
tickets, and recap of the next lines. House style keeps the trap and
the number.

docs(pf-vkdecode): tighten comments to house style ... 88cafa47c9

Comments in this crate were self-discussion: plan sections, review
tickets, and recap of the next lines. House style keeps the trap and
the number.

docs(pf-win-display): tighten comments to house style ... 24c36c9fa7

Comments in this crate were self-discussion: plan sections, review
tickets, and recap of the next lines. House style keeps the trap and
the number.

docs(pf-zerocopy): tighten comments to house style ... 569e9bc350

Comments in this crate were self-discussion: plan sections, review
tickets, and recap of the next lines. House style keeps the trap and
the number.

docs(punktfunk-core): tighten comments to house style ... 02fd0fda8f

Comments in this crate were self-discussion: plan sections, review
tickets, and recap of the next lines. House style keeps the trap and
the number.

docs(punktfunk-host): tighten comments to house style ... 2e9844e7e4

Comments in this crate were self-discussion: plan sections, review
tickets, and recap of the next lines. House style keeps the trap and
the number.

docs(punktfunk-setup): tighten comments to house style ... 7abc94a59e

Comments in this crate were self-discussion: plan sections, review
tickets, and recap of the next lines. House style keeps the trap and
the number.

docs(punktfunk-tray): tighten comments to house style ... ad41ca94f2

Comments in this crate were self-discussion: plan sections, review
tickets, and recap of the next lines. House style keeps the trap and
the number.

luxus force-pushed docs/comment-sweep from e6385090b3 to ad41ca94f2 2026-09-02 00:14:58 +00:00 Compare

luxus added 1 commit 2026-09-02 00:16:29 +00:00

chore(writing): drop comment-sweep workflows from the PR ... 848905a769

The sweep already landed as crate commits. The orchestration
scripts do not belong on this branch.

enricobuehler merged commit f28cbf1c4c into main 2026-09-02 00:18:26 +00:00

enricobuehler deleted branch docs/comment-sweep 2026-09-02 00:18:30 +00:00

enricobuehler referenced this issue from a commit 2026-09-02 00:40:04 +00:00

fix(sweep): repair syntax and formatting after the comment sweep

enricobuehler referenced this pull request 2026-09-02 00:40:16 +00:00

fix(sweep): repair syntax and formatting after the comment sweep #520

enricobuehler referenced this issue from a commit 2026-09-02 00:57:05 +00:00

fix(sweep): restore two code lines the comment sweep deleted

enricobuehler referenced this pull request 2026-09-02 00:57:24 +00:00

fix(sweep): restore two code lines the comment sweep deleted #523

enricobuehler referenced this pull request 2026-09-02 07:54:06 +00:00

fix(ci): clear the two remaining main-wide lane failures #533

enricobuehler referenced this pull request 2026-09-02 08:14:08 +00:00

fix(inject): separate the sc doc list from its trailing paragraph #539

Sign in to join this conversation.

Reviewers

No Reviewers

Labels

No items

No labels

Milestone

No items

No Milestone

Projects

Clear projects

No projects

Assignees

Clear assignees

FernandoMX FlipperDan HitFrostbite Seenko bluelightspecial enricobuehler (Enrico Bühler) kszlim luxus nannku neoney sonar

No Assignees

1 Participants

Notifications

Subscribe

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: unom/punktfunk#514

Allow edits from maintainers