docs(stovepipe): remove redundant queue storage comments

Author: mnoah1

stovepipe/entity/queue.go

@@ -61,7 +61,6 @@ type Queue struct {
 	Version int32 `json:"version"`
 }
 
-// EnablementState returns the applied occurrence independently of operational row version.
 func (q Queue) EnablementState() QueueState {
 	return QueueState{Queue: q.Name, State: q.Enablement, Version: q.EnablementVersion,
 		EffectiveFromCommitURI: q.EffectiveFromCommitURI, ChangedAtMs: q.EnablementChangedAtMs}

stovepipe/entity/queue_log.go

@@ -37,13 +37,11 @@ func QueueLogID(version int64) string {
 	return fmt.Sprintf("state/%d", version)
 }
 
-// Snapshot returns the applied state represented by the occurrence.
 func (l QueueLog) Snapshot() QueueState {
 	return QueueState{Queue: l.Queue, State: l.State, Version: l.QueueStateVersion,
 		EffectiveFromCommitURI: l.EffectiveFromCommitURI, ChangedAtMs: l.TimestampMs}
 }
 
-// Validate verifies a retained occurrence's identity and snapshot invariants.
 func (l QueueLog) Validate() error {
 	if l.ID != QueueLogID(l.QueueStateVersion) {
 		return fmt.Errorf("queue state log identity differs from its state version")

stovepipe/entity/queue_state.go

@@ -22,13 +22,11 @@ type QueueEnablement string
 const (
 	// QueueEnablementUnknown is unset and never an explicit disablement.
 	QueueEnablementUnknown QueueEnablement = ""
-	// QueueEnablementEnabled identifies enabled queue coverage.
 	QueueEnablementEnabled QueueEnablement = "enabled"
-	// QueueEnablementDisabled identifies disabled queue coverage.
 	QueueEnablementDisabled QueueEnablement = "disabled"
 )
 
-// QueueState is one applied enablement occurrence, independent of storage row versions.
+// QueueState describes applied enablement, independent of storage row versions.
 type QueueState struct {
 	// Queue is the stable repo-and-ref namespace, at most 255 bytes.
 	Queue string
@@ -38,11 +36,10 @@ type QueueState struct {
 	EffectiveFromCommitURI string
 	// ChangedAtMs is the application timestamp in Unix milliseconds.
 	ChangedAtMs int64
-	// Version is the positive queue-scoped state version.
+	// Version is the positive queue-scoped enablement sequence.
 	Version int64
 }
 
-// Validate verifies the invariants of a persisted state snapshot.
 func (s QueueState) Validate() error {
 	if s.Queue == "" || len(s.Queue) > 255 || s.Version <= 0 || s.ChangedAtMs <= 0 {
 		return fmt.Errorf("invalid queue state identity, version or timestamp")

stovepipe/entity/queue_summary.go

@@ -32,13 +32,11 @@ type QueueSummary struct {
 	Version int64
 }
 
-// Snapshot returns the enablement occurrence represented by this summary.
 func (s QueueSummary) Snapshot() QueueState {
 	return QueueState{Queue: s.Queue, State: s.State, Version: s.QueueStateVersion,
 		EffectiveFromCommitURI: s.EffectiveFromCommitURI, ChangedAtMs: s.StateTimestampMs}
 }
 
-// Validate verifies projection identity, version and represented state.
 func (s QueueSummary) Validate() error {
 	if s.Version <= 0 {
 		return fmt.Errorf("invalid queue summary version")

stovepipe/extension/storage/mysql/queue_log_store.go

@@ -32,7 +32,6 @@ type queueLogStore struct {
 	queue string
 }
 
-// NewQueueLogStore binds immutable MySQL occurrences to one queue.
 func NewQueueLogStore(db *sql.DB, scope tally.Scope, queue string) storage.QueueLogStore {
 	return &queueLogStore{db: db, scope: scope, queue: queue}
 }

stovepipe/extension/storage/mysql/queue_summary_store.go

@@ -32,7 +32,6 @@ type queueSummaryStore struct {
 	queue string
 }
 
-// NewQueueSummaryStore binds a MySQL queue summary store to one queue.
 func NewQueueSummaryStore(db *sql.DB, scope tally.Scope, queue string) storage.QueueSummaryStore {
 	return &queueSummaryStore{db: db, scope: scope, queue: queue}
 }

stovepipe/extension/storage/mysql/storage.go

@@ -121,10 +121,8 @@ func (f *mysqlStorage) GetValidationFactStore() storage.ValidationFactStore {
 	return f.validationFactStore
 }
 
-// GetQueueSummaryStore returns the bound queue-summary store.
 func (f *mysqlStorage) GetQueueSummaryStore() storage.QueueSummaryStore { return f.queueSummaryStore }
 
-// GetQueueLogStore returns the bound immutable-history store.
 func (f *mysqlStorage) GetQueueLogStore() storage.QueueLogStore {
 	return f.queueLogStore
 }

stovepipe/extension/storage/storage.go

@@ -87,10 +87,8 @@ type Storage interface {
 	// GetQueueStore returns the QueueStore instance.
 	GetQueueStore() QueueStore
 
-	// GetQueueSummaryStore returns the derived queue status summary.
 	GetQueueSummaryStore() QueueSummaryStore
 
-	// GetQueueLogStore returns immutable enablement history.
 	GetQueueLogStore() QueueLogStore
 
 	// GetBuildStore returns the BuildStore instance.