Update docs

Author: cschleiden

backend/redis/options.go

@@ -19,26 +19,20 @@ type RedisOptions struct {
 
 type RedisBackendOption func(*RedisOptions)
 
+// WithKeyPrefix sets the prefix for all keys used in the Redis backend.
 func WithKeyPrefix(prefix string) RedisBackendOption {
 	return func(o *RedisOptions) {
 		o.KeyPrefix = prefix
 	}
 }
 
+// WithBlockTimeout sets the timeout for blocking operations like dequeuing a workflow or activity task
 func WithBlockTimeout(timeout time.Duration) RedisBackendOption {
 	return func(o *RedisOptions) {
 		o.BlockTimeout = timeout
 	}
 }
 
-func WithBackendOptions(opts ...backend.BackendOption) RedisBackendOption {
-	return func(o *RedisOptions) {
-		for _, opt := range opts {
-			opt(&o.Options)
-		}
-	}
-}
-
 // WithAutoExpiration sets the duration after which finished runs will expire from the data store.
 // If set to 0 (default), runs will never expire and need to be manually removed.
 func WithAutoExpiration(expireFinishedRunsAfter time.Duration) RedisBackendOption {
@@ -55,3 +49,11 @@ func WithAutoExpirationContinueAsNew(expireContinuedAsNewRunsAfter time.Duration
 		o.AutoExpirationContinueAsNew = expireContinuedAsNewRunsAfter
 	}
 }
+
+func WithBackendOptions(opts ...backend.BackendOption) RedisBackendOption {
+	return func(o *RedisOptions) {
+		for _, opt := range opts {
+			opt(&o.Options)
+		}
+	}
+}

docs/source/includes/_backends.md

@@ -68,6 +68,7 @@ Create a new Redis backend instance with `NewRedisBackend`.
 
 ### Options
 
+- `WithKeyPrefix` - Set the key prefix for all keys. Defaults to `""`
 - `WithBlockTimeout(timeout time.Duration)` - Set the timeout for blocking operations. Defaults to `5s`
 - `WithAutoExpiration(expireFinishedRunsAfter time.Duration)` - Set the expiration time for finished runs. Defaults to `0`, which never expires runs
 - `WithAutoExpirationContinueAsNew(expireContinuedAsNewRunsAfter time.Duration)` - Set the expiration time for continued as new runs. Defaults to `0`, which uses the same value as `WithAutoExpiration`