mirrors/sigma

0 Fork 0

mirror of https://github.com/go-sigma/sigma.git synced 2026-10-29 11:07:19 +08:00

Files

T

History

Tosone f677ad3f5f docs: complete placeholder doc comments across the codebase

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

2026-09-14 14:58:06 +08:00

README.md

chore: initial commit

2026-08-01 20:32:49 +08:00

reference_test.go

chore: initial commit

2026-08-01 20:32:49 +08:00

reference.go

docs: complete placeholder doc comments across the codebase

2026-09-14 14:58:06 +08:00

README.md

reference

import "github.com/go-sigma/sigma/pkg/distribution/reference"

Package reference ...

Index

func Normalized(name string) (string, error)
func Parse(name string) (string, string, string, string, error)
type NamespacedRepo
- func MakeNRFromString(s string) *NamespacedRepo
- func (nr *NamespacedRepo) String() string

func Normalized

func Normalized(name string) (string, error)

Normalized ...

func Parse

func Parse(name string) (string, string, string, string, error)

Parse ...

type NamespacedRepo

NamespacedRepo consist of Namespace and Repository, usually representing a concrete form of TargetItem

type NamespacedRepo struct {
    Namespace  string `json:"namespace"`
    Repository string `json:"repository"`
}

func MakeNRFromString

func MakeNRFromString(s string) *NamespacedRepo

MakeNRFromString make a namespaced repo from a string. string should be in a format as "{namespace}/{repo}"

func (*NamespacedRepo) String

func (nr *NamespacedRepo) String() string

String ...

Generated by gomarkdoc