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:
@@ -23,7 +23,7 @@ func New(w io.Writer, level, format string) (*slog.Logger, error) {
|
||||
default:
|
||||
return nil, fmt.Errorf("unknown log format %q (want text|json)", format)
|
||||
}
|
||||
// Errors are also kept for the admin Overview (M504).
|
||||
// Errors are also kept for the admin Overview.
|
||||
return slog.New(newRingHandler(h, Errors)), nil
|
||||
}
|
||||
|
||||
|
||||
@@ -9,7 +9,7 @@ import (
|
||||
"time"
|
||||
)
|
||||
|
||||
// The server's recent errors, kept in memory for the admin Overview (M504):
|
||||
// The server's recent errors, kept in memory for the admin Overview:
|
||||
// what has gone wrong since the process started, without reading the
|
||||
// container's logs. Only ERROR and above, and only the newest few; the full
|
||||
// record is still the log stream.
|
||||
|
||||
Reference in New Issue
Block a user