Added doc comments for shared stage schema functions

arcalot · Sep 27, 2024 · 4f8202e · 4f8202e
1 parent 1cdf151
commit 4f8202e
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/internal/step/foreach/provider.go b/internal/step/foreach/provider.go
@@ -772,7 +772,6 @@ func (r *runningStep) runOnInput() {
 }
 
 func (r *runningStep) processInput(inputData []any) {
-	// TODO: Transition to reusable functions
 	r.logger.Debugf("Executing subworkflow for step %s...", r.runID)
 	outputs, errors := r.executeSubWorkflows(inputData)
 

diff --git a/internal/step/shared_schema.go b/internal/step/shared_schema.go
@@ -2,6 +2,8 @@ package step
 
 import "go.flow.arcalot.io/pluginsdk/schema"
 
+// EnabledOutputSchema returns the schema for the enabled stage that is
+// implemented in several step types.
 func EnabledOutputSchema() *schema.StepOutputSchema {
 	return schema.NewStepOutputSchema(
 		schema.NewScopeSchema(
@@ -29,6 +31,8 @@ func EnabledOutputSchema() *schema.StepOutputSchema {
 	)
 }
 
+// DisabledOutputSchema returns the schema for the disabled stage that is
+// implemented in several step types.
 func DisabledOutputSchema() *schema.StepOutputSchema {
 	return schema.NewStepOutputSchema(
 		schema.NewScopeSchema(