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:
@@ -70,7 +70,8 @@ type updateCoverSourceResp struct {
|
||||
VersionBumped bool `json:"version_bumped"`
|
||||
}
|
||||
|
||||
// handleUpdateCoverSource implements PATCH /api/admin/cover-sources/{provider_id}.
|
||||
// handleUpdateCoverSource implements PATCH
|
||||
// /api/admin/cover-sources/{provider_id}.
|
||||
func (h *handlers) handleUpdateCoverSource(w http.ResponseWriter, r *http.Request) {
|
||||
id := chi.URLParam(r, "provider_id")
|
||||
|
||||
@@ -128,7 +129,8 @@ type testCoverSourceResp struct {
|
||||
Error string `json:"error,omitempty"`
|
||||
}
|
||||
|
||||
// handleTestCoverSource implements POST /api/admin/cover-sources/{provider_id}/test.
|
||||
// handleTestCoverSource implements POST
|
||||
// /api/admin/cover-sources/{provider_id}/test.
|
||||
func (h *handlers) handleTestCoverSource(w http.ResponseWriter, r *http.Request) {
|
||||
id := chi.URLParam(r, "provider_id")
|
||||
|
||||
|
||||
Reference in New Issue
Block a user