Merge pull request #409 from cschleiden/document-backend-options

Document backend options

Author: cschleiden

backend/options.go

@@ -70,54 +70,74 @@ var DefaultOptions Options = Options{
 
 type BackendOption func(*Options)
 
+// WithStickyTimeout sets the sticky timeout duration for workflow executions.
+// This determines how long a worker will hold onto a workflow execution context
+// before releasing it back to the task queue.
 func WithStickyTimeout(timeout time.Duration) BackendOption {
 	return func(o *Options) {
 		o.StickyTimeout = timeout
 	}
 }
 
+// WithLogger sets a custom logger for the backend.
+// If not set, slog.Default() will be used.
 func WithLogger(logger *slog.Logger) BackendOption {
 	return func(o *Options) {
 		o.Logger = logger
 	}
 }
 
+// WithMetrics sets a custom metrics client for collecting workflow execution metrics.
+// If not set, a no-op metrics client will be used.
 func WithMetrics(client metrics.Client) BackendOption {
 	return func(o *Options) {
 		o.Metrics = client
 	}
 }
 
+// WithTracerProvider sets a custom OpenTelemetry tracer provider for distributed tracing.
+// If not set, a no-op tracer provider will be used.
 func WithTracerProvider(tp trace.TracerProvider) BackendOption {
 	return func(o *Options) {
 		o.TracerProvider = tp
 	}
 }
 
+// WithConverter sets a custom converter for serializing and deserializing workflow inputs and results.
+// If not set, converter.DefaultConverter will be used.
 func WithConverter(converter converter.Converter) BackendOption {
 	return func(o *Options) {
 		o.Converter = converter
 	}
 }
 
+// WithContextPropagator adds a context propagator for passing context into workflows and activities.
+// Multiple propagators can be added by calling this function multiple times.
 func WithContextPropagator(prop workflow.ContextPropagator) BackendOption {
 	return func(o *Options) {
 		o.ContextPropagators = append(o.ContextPropagators, prop)
 	}
 }
 
+// WithRemoveContinuedAsNewInstances enables immediate removal of workflow instances
+// that completed using ContinueAsNew, including their history.
+// If not set, instances will be removed after the configured retention period or never.
 func WithRemoveContinuedAsNewInstances() BackendOption {
 	return func(o *Options) {
 		o.RemoveContinuedAsNewInstances = true
 	}
 }
 
+// WithMaxHistorySize sets the maximum size of a workflow history in bytes.
+// If a workflow exceeds this size, it will be failed to prevent unbounded growth.
 func WithMaxHistorySize(size int64) BackendOption {
 	return func(o *Options) {
 		o.MaxHistorySize = size
 	}
 }
 
+// WithWorkerName sets a custom name for this worker instance.
+// If not set, backends will generate a default name based on hostname and process ID.
 func WithWorkerName(workerName string) BackendOption {
 	return func(o *Options) {
 		o.WorkerName = workerName