docs: server comments say what the code does, not how it came to be (#6277)
Comment blocks in cmd/minstrel and 30 smaller internal packages, rewritten
to rule 32's standard with each citation read in context: task, milestone
and rule ids go, and so do the stories they were attached to ("used to",
"Before #N", measurements from one install, quotes, pointers to Fabled
Librarian's records and to docs/superpowers files that are not in the
repo). Where a story wrapped a real constraint, the constraint stays as a
present-tense fact.
Comments that had gone stale are corrected:
- taste.Config: the tuned values are overlaid by internal/recsettings;
it is no longer "a later follow-up".
- StorageConfig: the data dir holds art, caches and the stream secret,
not only playlist covers.
- the Subsonic album list and getUser comments describe what they do
today rather than a milestone that would change it.
Checked: the non-comment token stream of every changed file matches
HEAD, and gofmt -l is empty.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
@@ -19,18 +19,16 @@ import (
|
||||
// hits it every 5s and would otherwise drown real signals (~17k lines/day).
|
||||
//
|
||||
// Severity is keyed off the response status so 4xx/5xx surface even when
|
||||
// the operator's logger level is set above Info.
|
||||
// the logger level is set above Info.
|
||||
//
|
||||
// The `remote` attribute holds the address resolved through the operator's
|
||||
// configured reverse-proxy depth, NOT the raw socket peer (#2453). Behind a
|
||||
// proxy — the normal deployment for anything public — the socket peer is the
|
||||
// proxy, so every line would have carried the same useless address, and the
|
||||
// access log would have disagreed with the Active-sessions surface about who
|
||||
// connected. The attribute key is unchanged so existing log greps keep
|
||||
// working; only its accuracy improved.
|
||||
// The `remote` attribute holds the address resolved through the configured
|
||||
// reverse-proxy depth, NOT the raw socket peer. Behind a proxy — the normal
|
||||
// deployment for anything public — the socket peer is the proxy, so every
|
||||
// line would carry the same useless address, and the access log would
|
||||
// disagree with the Active-sessions list about who connected.
|
||||
//
|
||||
// trustedHops is a func because this middleware is constructed at boot while
|
||||
// the value is operator-editable at runtime, and — since Router() registers
|
||||
// the value is editable at runtime, and — since Router() registers
|
||||
// this before it builds the settings service — because it lets the accessor
|
||||
// be wired before the thing it reads exists. auth.ClientIP tolerates a depth
|
||||
// of 0, which is what a nil service reports.
|
||||
|
||||
Reference in New Issue
Block a user