mirror of
https://github.com/go-sigma/sigma.git
synced 2026-10-28 18:04:33 +08:00
Replace every `// <Identifier> ...` placeholder doc comment with a real description of the declared symbol. 276 comments in 71 files were rewritten: 149 top-level placeholders first, then a follow-up scan caught another 127 indented ones (interface methods and const blocks) that a column-anchored match had missed. Comments now open with the declared identifier and record the actual contract - behaviour, side effects, error/panic conditions, units, HTTP endpoints, lock keys and cache prefixes - instead of restating the signature. Three placeholders carried a stale identifier and were corrected to the declared symbol: ConfigurationDatabasePostgresql, GetImageRef and Initialize. No functional change: every modified line is a comment. Verification: - grep '^\s*//\s+\S+\s+\.\.\.\s*$' over all *.go returns no matches - gofmt -l over the changed files prints nothing - CGO_ENABLED=1 go build -tags "netgo,timetzdata,exclude_graphdriver_btrfs,containers_image_openpgp" ./... exits 0 - git diff HEAD -U0 filtered to non-comment changed lines is empty