chore: code-comments sweep slice 2/5 - cmd/coily/gh_* #88

New issue

Open

opened 2026-05-26 05:22:43 +00:00 by coilysiren · 0 comments

coilysiren commented

2026-05-26 05:22:43 +00:00

Owner

Problem

Subset of #334. After the rev: v0.2.8 bump, the agentic-os code-comments hook reports 249 violations across the cmd/coily/gh_* subsystem (8 files):

cmd/coily/gh_actions_gate.go
cmd/coily/gh_actions_gate_test.go
cmd/coily/gh_actions_web.go
cmd/coily/gh_actions_web_test.go
cmd/coily/gh_maxage.go
cmd/coily/gh_readcache.go
cmd/coily/gh_rest_rewrite.go
cmd/coily/gh_rest_rewrite_test.go

Coherent subsystem (gh passthrough cache + REST rewrite). Sweeping together keeps godoc style consistent across the surface.

Fix

Walk each contiguous comment block >2 lines:

Function godocs: collapse to first 2 lines or rewrite as a short pointer (// see docs/<topic>.md) when the detail is durable.
Test setup blocks: collapse aggressively, the test body documents itself.

No directive lines (//go:, //nolint:) inside violation blocks in this slice, so a mechanical truncate-to-2-and-keep-grammar pass is safe.

Verify:

pre-commit run code-comments --files cmd/coily/gh_*
make build && make test

Refs

Parent: #334
Dispatch survey: https://github.com/coilysiren/coily/issues/334#issuecomment-4539785886

Ported from coilysiren/coily#339.

**Problem** Subset of #334. After the `rev: v0.2.8` bump, the agentic-os `code-comments` hook reports 249 violations across the `cmd/coily/gh_*` subsystem (8 files): - `cmd/coily/gh_actions_gate.go` - `cmd/coily/gh_actions_gate_test.go` - `cmd/coily/gh_actions_web.go` - `cmd/coily/gh_actions_web_test.go` - `cmd/coily/gh_maxage.go` - `cmd/coily/gh_readcache.go` - `cmd/coily/gh_rest_rewrite.go` - `cmd/coily/gh_rest_rewrite_test.go` Coherent subsystem (gh passthrough cache + REST rewrite). Sweeping together keeps godoc style consistent across the surface. **Fix** Walk each contiguous comment block >2 lines: - Function godocs: collapse to first 2 lines or rewrite as a short pointer (`// see docs/<topic>.md`) when the detail is durable. - Test setup blocks: collapse aggressively, the test body documents itself. No directive lines (`//go:`, `//nolint:`) inside violation blocks in this slice, so a mechanical truncate-to-2-and-keep-grammar pass is safe. Verify: ``` pre-commit run code-comments --files cmd/coily/gh_* make build && make test ``` **Refs** - Parent: #334 - Dispatch survey: https://github.com/coilysiren/coily/issues/334#issuecomment-4539785886 --- _Ported from coilysiren/coily#339._

coilysiren added the

label

2026-05-31 01:52:40 +00:00

coilysiren added

and removed

labels

2026-05-31 06:59:45 +00:00

No labels

No milestone

No project

No assignees

1 participant

Notifications

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

coilyco-bridge/coily#88

No description provided.

Rows
Columns