Skip to content

Commit 3fb75ee

Browse files
committed
docs: add missing doc comments to run_result.go functions
1 parent 41a4e40 commit 3fb75ee

1 file changed

Lines changed: 7 additions & 0 deletions

File tree

test/e2e/benchmark/run_result.go

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -124,6 +124,8 @@ func emitRunResult(t testing.TB, cfg benchConfig, br *benchmarkResult, wallClock
124124
t.Logf("wrote structured result to %s", outputPath)
125125
}
126126

127+
// buildRunResult populates a runResult from the benchmark config, block metrics,
128+
// and trace-derived statistics.
127129
func buildRunResult(cfg benchConfig, br *benchmarkResult, wallClock time.Duration, spamoor *runSpamoorStats) *runResult {
128130
s := br.summary
129131

@@ -197,6 +199,8 @@ func buildRunResult(cfg benchConfig, br *benchmarkResult, wallClock time.Duratio
197199
}
198200
}
199201

202+
// setEngineSpanTimings populates the ProduceBlock, GetPayload, and NewPayload
203+
// avg/min/max fields on runMetrics from pre-aggregated span stats.
200204
func setEngineSpanTimings(m *runMetrics, stats map[string]*e2e.SpanStats) {
201205
type spanTarget struct {
202206
name string
@@ -221,6 +225,8 @@ func setEngineSpanTimings(m *runMetrics, stats map[string]*e2e.SpanStats) {
221225
}
222226
}
223227

228+
// evNodeTag returns the ev-node version for result tagging. Checks EV_NODE_TAG
229+
// env var first, then falls back to the vcs.revision build info, then "unknown".
224230
func evNodeTag() string {
225231
if tag := os.Getenv("EV_NODE_TAG"); tag != "" {
226232
return tag
@@ -239,6 +245,7 @@ func evNodeTag() string {
239245
return "unknown"
240246
}
241247

248+
// fieldDescriptions returns human-readable descriptions for every field in runResult.
242249
func fieldDescriptions() map[string]string {
243250
return map[string]string{
244251
"config.block_time": "target block production interval",

0 commit comments

Comments
 (0)