docs: document DRY in code

Signed-off-by: Michael Adler <[email protected]>
siemens · Oct 16, 2023 · 309a4bc · 309a4bc
1 parent 6a1c2ed
commit 309a4bc
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/api/northbound.go b/api/northbound.go
@@ -279,6 +279,8 @@ func NewNorthboundAPI(storage persistence.Storage) *operations.WorkflowExecutorA
 }
 
 func parseFilterParamsNorth(params northbound.GetJobsEventsParams) events.FilterParams {
+	// same code as parseFilterParamsSouth but params is from a different package;
+	// this isn't pretty (DRY) but we have a conceptually clear distinction
 	var filter events.FilterParams
 	if ids := params.JobIds; ids != nil {
 		filter.JobIDs = strings.Split(*ids, ",")

diff --git a/api/southbound.go b/api/southbound.go
@@ -192,6 +192,8 @@ func NewSouthboundAPI(storage persistence.Storage) *operations.WorkflowExecutorA
 }
 
 func parseFilterParamsSouth(params southbound.GetJobsEventsParams) events.FilterParams {
+	// same code as parseFilterParamsNorth but params is from a different package;
+	// this isn't pretty (DRY) but we have a conceptually clear distinction
 	var filter events.FilterParams
 	if ids := params.JobIds; ids != nil {
 		filter.JobIDs = strings.Split(*ids, ",")