Rename config

Author: cschleiden

registry/registry.go

@@ -18,19 +18,20 @@ type Registry struct {
 	activityMap map[string]interface{}
 }
 
+// New creates a new registry instance.
 func New() *Registry {
 	return &Registry{
 		workflowMap: make(map[string]wf.Workflow),
 		activityMap: make(map[string]interface{}),
 	}
 }
 
-type RegisterConfig struct {
+type registerConfig struct {
 	Name string
 }
 
 func (r *Registry) RegisterWorkflow(workflow wf.Workflow, opts ...RegisterOption) error {
-	cfg := registerOptions(opts).applyRegisterOptions(RegisterConfig{})
+	cfg := registerOptions(opts).applyRegisterOptions(registerConfig{})
 	name := cfg.Name
 	if name == "" {
 		name = fn.Name(workflow)
@@ -75,7 +76,7 @@ func (r *Registry) RegisterWorkflow(workflow wf.Workflow, opts ...RegisterOption
 }
 
 func (r *Registry) RegisterActivity(activity wf.Activity, opts ...RegisterOption) error {
-	cfg := registerOptions(opts).applyRegisterOptions(RegisterConfig{})
+	cfg := registerOptions(opts).applyRegisterOptions(registerConfig{})
 
 	t := reflect.TypeOf(activity)
 

registry/registry_option.go

@@ -1,26 +1,26 @@
 package registry
 
 type RegisterOption interface {
-	applyRegisterOption(RegisterConfig) RegisterConfig
+	applyRegisterOption(registerConfig) registerConfig
 }
 
 type registerOptions []RegisterOption
 
-func (opts registerOptions) applyRegisterOptions(cfg RegisterConfig) RegisterConfig {
+func (opts registerOptions) applyRegisterOptions(cfg registerConfig) registerConfig {
 	for _, opt := range opts {
 		cfg = opt.applyRegisterOption(cfg)
 	}
 	return cfg
 }
 
-type registerOptionFunc func(RegisterConfig) RegisterConfig
+type registerOptionFunc func(registerConfig) registerConfig
 
-func (f registerOptionFunc) applyRegisterOption(cfg RegisterConfig) RegisterConfig {
+func (f registerOptionFunc) applyRegisterOption(cfg registerConfig) registerConfig {
 	return f(cfg)
 }
 
 func WithName(name string) RegisterOption {
-	return registerOptionFunc(func(cfg RegisterConfig) RegisterConfig {
+	return registerOptionFunc(func(cfg registerConfig) registerConfig {
 		cfg.Name = name
 		return cfg
 	})

worker/worker.go

@@ -93,6 +93,7 @@ func (w *Worker) Start(ctx context.Context) error {
 	return nil
 }
 
+// WaitForCompletion waits for all active tasks to complete.
 func (w *Worker) WaitForCompletion() error {
 	if err := w.workflowWorker.WaitForCompletion(); err != nil {
 		return err
@@ -105,10 +106,12 @@ func (w *Worker) WaitForCompletion() error {
 	return nil
 }
 
+// RegisterWorkflow registers a workflow with the worker's registry.
 func (w *Worker) RegisterWorkflow(wf workflow.Workflow, opts ...registry.RegisterOption) error {
 	return w.registry.RegisterWorkflow(wf, opts...)
 }
 
+// RegisterActivity registers an activity with the worker's registry.
 func (w *Worker) RegisterActivity(a workflow.Activity, opts ...registry.RegisterOption) error {
 	return w.registry.RegisterActivity(a, opts...)
 }