docs: api comments say what the endpoints do, not how they came to be (#6277)
Rewrites the internal/api comment blocks to rule 32: task, milestone and rule ids gone, the stories behind them restated as the constraint they left, stale references corrected (the stream secret is wired from config, the timezone handler already refreshes the scheduler, the Android app is the native client, the design docs cited are not in the repo). Also rewraps comment lines over 80 columns left by the earlier batches. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
@@ -11,7 +11,7 @@ import (
|
||||
"git.fabledsword.com/bvandeusen/minstrel/internal/library"
|
||||
)
|
||||
|
||||
// AcoustID recording-id lookup, admin side (M401 #3922).
|
||||
// AcoustID recording-id lookup, admin side.
|
||||
|
||||
// acoustIDUnsettledLimit caps the admin list of tracks a lookup could not
|
||||
// settle. It is a list to read, not to page through.
|
||||
@@ -96,7 +96,8 @@ type acoustIDSettingsReq struct {
|
||||
APIKey *string `json:"api_key"`
|
||||
}
|
||||
|
||||
// handleUpdateAcoustIDSettings implements PUT /api/admin/library/acoustid-settings.
|
||||
// handleUpdateAcoustIDSettings implements PUT
|
||||
// /api/admin/library/acoustid-settings.
|
||||
func (h *handlers) handleUpdateAcoustIDSettings(w http.ResponseWriter, r *http.Request) {
|
||||
var req acoustIDSettingsReq
|
||||
if err := json.NewDecoder(r.Body).Decode(&req); err != nil {
|
||||
@@ -143,9 +144,9 @@ type acoustIDUnsettledResp struct {
|
||||
LookedUpAt time.Time `json:"looked_up_at"`
|
||||
}
|
||||
|
||||
// handleListUnsettledAcoustID implements GET /api/admin/library/acoustid/unsettled:
|
||||
// the tracks a lookup could not settle (ambiguous or failed), so they can be
|
||||
// found and tagged by hand.
|
||||
// handleListUnsettledAcoustID implements GET
|
||||
// /api/admin/library/acoustid/unsettled: the tracks a lookup could not settle
|
||||
// (ambiguous or failed), so they can be found and tagged by hand.
|
||||
func (h *handlers) handleListUnsettledAcoustID(w http.ResponseWriter, r *http.Request) {
|
||||
rows, err := dbq.New(h.pool).ListUnsettledAcoustIDLookups(r.Context(), acoustIDUnsettledLimit)
|
||||
if err != nil {
|
||||
|
||||
Reference in New Issue
Block a user