Skip to content

Commit c00e6cc

Browse files
committed
Updated godoc
1 parent f0aeedf commit c00e6cc

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

module/builder/collection/builder.go

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -405,6 +405,11 @@ func (b *Builder) populateFinalizedAncestryLookup(lctx lockctx.Proof, ctx *block
405405

406406
// buildPayload constructs a valid payload based on transactions available in the mempool.
407407
// If the mempool is empty, an empty payload will be returned.
408+
// Return values:
409+
// - *cluster.Payload: the payload that has been built.
410+
// - uint: number of prioritized transactions included in the payload.
411+
// - error: exception if failed to build the payload.
412+
//
408413
// No errors are expected during normal operation.
409414
func (b *Builder) buildPayload(buildCtx *blockBuildContext) (*cluster.Payload, uint, error) {
410415
lookup := buildCtx.lookup

0 commit comments

Comments
 (0)