mirror of
https://github.com/go-sigma/sigma.git
synced 2026-10-28 19:34: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
35 lines
1.2 KiB
Go
35 lines
1.2 KiB
Go
// Copyright 2023 sigma
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
package models
|
|
|
|
import (
|
|
"gorm.io/plugin/soft_delete"
|
|
|
|
"github.com/go-sigma/sigma/pkg/api/enums"
|
|
)
|
|
|
|
// WorkQueue stores a queued daemon task to be executed asynchronously, keyed by topic and payload with its processing status.
|
|
type WorkQueue struct {
|
|
CreatedAt int64 `gorm:"autoCreateTime:milli"`
|
|
UpdatedAt int64 `gorm:"autoUpdateTime:milli"`
|
|
DeletedAt soft_delete.DeletedAt `gorm:"softDelete:milli"`
|
|
ID string `gorm:"primaryKey;size:36"`
|
|
|
|
Topic enums.Daemon
|
|
Payload []byte
|
|
Version string
|
|
Status enums.TaskCommonStatus `gorm:"default:Pending"`
|
|
}
|