Skip to content

Commit 88a7d45

Browse files
committed
Refactor pusher engine: add error return doc comments
1 parent ad04f27 commit 88a7d45

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

engine/collection/pusher/engine.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -119,6 +119,7 @@ func (e *Engine) outboundQueueWorker(ctx irrecoverable.SignalerContext, ready co
119119

120120
// processOutboundMessages processes any available messages from the queue.
121121
// Only returns when the queue is empty (or the engine is terminated).
122+
// No errors expected during normal operations.
122123
func (e *Engine) processOutboundMessages(ctx context.Context) error {
123124
for {
124125
nextMessage, ok := e.queue.Pop()
@@ -190,6 +191,7 @@ func (e *Engine) SubmitCollectionGuarantee(msg *messages.SubmitCollectionGuarant
190191
}
191192

192193
// publishCollectionGuarantee publishes the collection guarantee to all consensus nodes.
194+
// No errors expected during normal operation.
193195
func (e *Engine) publishCollectionGuarantee(guarantee *flow.CollectionGuarantee) error {
194196
consensusNodes, err := e.state.Final().Identities(filter.HasRole[flow.Identity](flow.RoleConsensus))
195197
if err != nil {

0 commit comments

Comments
 (0)