doc(das): doc the sampling window param

celestiaorg · Dec 4, 2023 · 3a56040 · 3a56040
1 parent 6ff0b15
commit 3a56040
Showing 1 changed file with 4 additions and 3 deletions.
diff --git a/das/options.go b/das/options.go
@@ -41,7 +41,9 @@ type Parameters struct {
 	// ConcurrencyLimit.
 	SampleTimeout time.Duration
 
-	// TODO @renaynay: DOC
+	// SamplingWindow determines the time window that headers should fall into
+	// in order to be sampled. If set to 0, the sampling window will include
+	// all headers.
 	SamplingWindow time.Duration
 }
 
@@ -160,8 +162,7 @@ func WithSampleTimeout(sampleTimeout time.Duration) Option {
 }
 
 // WithSamplingWindow is a functional option to configure the DASer's
-// `SamplingWindow` parameter which determines the time window that
-// headers should fall into in order to be sampled.
+// `SamplingWindow` parameter.
 func WithSamplingWindow(samplingWindow time.Duration) Option {
 	return func(d *DASer) {
 		d.params.SamplingWindow = samplingWindow