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:
@@ -3,7 +3,7 @@ package release
|
||||
import "slices"
|
||||
|
||||
// Comparing a file against a MusicBrainz track: shared by the importer's
|
||||
// check of a download and the library listing's match of an album (#5569).
|
||||
// check of a download and the library listing's match of an album.
|
||||
|
||||
// LengthFits allows five seconds or 3%, whichever is more: remasters and
|
||||
// rips differ by a second or two, a different recording by far more. A
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
// Package release reads music release names and judges them against a
|
||||
// wanted album (M502 #5521): what a name says it is (format, bitrate, bit
|
||||
// wanted album: what a name says it is (format, bitrate, bit
|
||||
// depth, source, year, edition), whether it is the album wanted, and which
|
||||
// quality tier it sits in. Nothing here touches the network or the database,
|
||||
// so every rule is testable on a string.
|
||||
|
||||
@@ -44,7 +44,7 @@ var Tiers = []TierInfo{
|
||||
}
|
||||
|
||||
// DefaultTiers is what a new install allows: every format from trash lossy
|
||||
// to lossless (note #5527). Unknown is left out; a
|
||||
// to lossless. Unknown is left out; a
|
||||
// release that names no format has its .torrent read to find out.
|
||||
var DefaultTiers = []Tier{
|
||||
TierLosslessHiRes, TierLossless, TierLossyHigh, TierLossyStandard,
|
||||
@@ -151,7 +151,7 @@ func khz(f float64) string {
|
||||
return strings.TrimSuffix(strconv.FormatFloat(f, 'f', 1, 64), ".0")
|
||||
}
|
||||
|
||||
// Profile is which tiers the operator takes.
|
||||
// Profile is which tiers an install takes.
|
||||
type Profile struct {
|
||||
Allowed map[Tier]bool
|
||||
}
|
||||
@@ -216,7 +216,7 @@ func FileKbps(bytes, ms int64) int {
|
||||
// mp3High is the average bitrate from which an MP3 counts as high quality
|
||||
// when only its size is known. A V0 encode averages 220 to 260 kbps, so the
|
||||
// line sits below it: an estimate errs toward the copy held, and an album is
|
||||
// never fetched again on a guess (#5524).
|
||||
// never fetched again on a guess.
|
||||
const mp3High = 220
|
||||
|
||||
// TierOfFile places files of one format on the ladder from their average
|
||||
|
||||
@@ -16,7 +16,7 @@ func TestParse_ReadsWhatTheNameSays(t *testing.T) {
|
||||
rate float64
|
||||
tier Tier
|
||||
}{
|
||||
// The wrong edition grabbed on 2026-10-09 (note #5527).
|
||||
// A bracketed edition with its own year: not the original album.
|
||||
{"Daft Punk Random Access Memories (Drumless Edition 2023) [Flac 24-88]", FormatFLAC, "", "", 0, 24, 2023, 88.2, TierLosslessHiRes},
|
||||
{"Gorillaz - Humanz - (Japanese Edition) - [CD-FLAC] 2017", FormatFLAC, "", SourceCD, 0, 0, 2017, 0, TierLossless},
|
||||
{"Radiohead - OK Computer (1997) [MP3 320]", FormatMP3, "", "", 320, 0, 1997, 0, TierLossyHigh},
|
||||
|
||||
@@ -10,7 +10,7 @@ import (
|
||||
"strings"
|
||||
)
|
||||
|
||||
// Reading a .torrent file, ported from Fabled Librarian (#4463). A .torrent
|
||||
// Reading a .torrent file. A .torrent
|
||||
// is the metadata: its info dictionary names every file, and its SHA-1 is the
|
||||
// infohash. So a release offered as a .torrent link can be judged on what it
|
||||
// holds before any of it is downloaded. Bencode is four shapes; walking them
|
||||
|
||||
@@ -5,7 +5,7 @@ import "strings"
|
||||
// TitleVersion is the version of a recording a release group's title names
|
||||
// in its qualifier: the words in brackets, or after a dash. MusicBrainz
|
||||
// does not always type such a group: My Chemical Romance's "Common People
|
||||
// (Recorded For BBC Radio 1)" is a plain Single (#5573). Typ is the
|
||||
// (Recorded For BBC Radio 1)" is a plain Single. Typ is the
|
||||
// MusicBrainz secondary type the version is, or "" for one no type names
|
||||
// (an acoustic or instrumental version); Word is the word that said so.
|
||||
type TitleVersion struct {
|
||||
|
||||
@@ -4,7 +4,7 @@ import "testing"
|
||||
|
||||
func TestVersionInTitle(t *testing.T) {
|
||||
for title, want := range map[string]string{
|
||||
// My Chemical Romance's groups MusicBrainz types as plain Singles (#5573).
|
||||
// Groups MusicBrainz types as plain Singles, named by their title.
|
||||
"Common People (Recorded For BBC Radio 1)": "Live",
|
||||
"Welcome to the Black Parade (Steve Aoki remix)": "Remix",
|
||||
"The Five of Us Are Dying (Rough mix)": "Demo",
|
||||
|
||||
Reference in New Issue
Block a user