# HG changeset patch
# User Tom Gottfried <tom@intevation.de>
# Date 1584721443 -3600
# Node ID 56c589f7435d1fbdc4b682c0b8a261b24e1fb0b8
# Parent  59a99655f34d28fb24e8f7d3d9c214b58428290a
Enhance comments on implementations of StageDone()

diff -r 59a99655f34d -r 56c589f7435d pkg/imports/agm.go
--- a/pkg/imports/agm.go	Fri Mar 20 12:28:04 2020 +0100
+++ b/pkg/imports/agm.go	Fri Mar 20 17:24:03 2020 +0100
@@ -88,6 +88,7 @@
 )`
 )
 
+// StageDone replaces gauge measurements with those in the staging area
 func (agmJobCreator) StageDone(
 	ctx context.Context,
 	tx *sql.Tx,
diff -r 59a99655f34d -r 56c589f7435d pkg/imports/fa.go
--- a/pkg/imports/fa.go	Fri Mar 20 12:28:04 2020 +0100
+++ b/pkg/imports/fa.go	Fri Mar 20 17:24:03 2020 +0100
@@ -187,8 +187,7 @@
 
 func (faJobCreator) AutoAccept() bool { return true }
 
-// StageDone moves the imported fairway availablities out of the staging area.
-// Currently doing nothing.
+// StageDone is a NOP for fairway availability imports.
 func (faJobCreator) StageDone(context.Context, *sql.Tx, int64, Feedback) error {
 	return nil
 }
diff -r 59a99655f34d -r 56c589f7435d pkg/imports/fd.go
--- a/pkg/imports/fd.go	Fri Mar 20 12:28:04 2020 +0100
+++ b/pkg/imports/fd.go	Fri Mar 20 17:24:03 2020 +0100
@@ -98,6 +98,7 @@
 	}
 }
 
+// StageDone replaces fairway dimensions with those in the staging area
 func (fdJobCreator) StageDone(
 	ctx context.Context,
 	tx *sql.Tx,
diff -r 59a99655f34d -r 56c589f7435d pkg/imports/gm.go
--- a/pkg/imports/gm.go	Fri Mar 20 12:28:04 2020 +0100
+++ b/pkg/imports/gm.go	Fri Mar 20 17:24:03 2020 +0100
@@ -145,8 +145,7 @@
 
 func (gmJobCreator) AutoAccept() bool { return true }
 
-// StageDone moves the imported gauge measurement out of the staging area.
-// Currently doing nothing.
+// StageDone is a NOP for gauge measurements imports.
 func (gmJobCreator) StageDone(context.Context, *sql.Tx, int64, Feedback) error {
 	return nil
 }
diff -r 59a99655f34d -r 56c589f7435d pkg/imports/isr.go
--- a/pkg/imports/isr.go	Fri Mar 20 12:28:04 2020 +0100
+++ b/pkg/imports/isr.go	Fri Mar 20 17:24:03 2020 +0100
@@ -41,6 +41,7 @@
 
 func (isrJobCreator) Create() Job { return new(IsoRefresh) }
 
+// StageDone is a NOP for IsoRefresh imports.
 func (isrJobCreator) StageDone(context.Context, *sql.Tx, int64, Feedback) error {
 	return nil
 }
diff -r 59a99655f34d -r 56c589f7435d pkg/imports/sr.go
--- a/pkg/imports/sr.go	Fri Mar 20 12:28:04 2020 +0100
+++ b/pkg/imports/sr.go	Fri Mar 20 17:24:03 2020 +0100
@@ -109,6 +109,7 @@
 	}
 }
 
+// StageDone moves the imported sounding result out of the staging area.
 func (srJobCreator) StageDone(
 	ctx context.Context,
 	tx *sql.Tx,
diff -r 59a99655f34d -r 56c589f7435d pkg/imports/ufa.go
--- a/pkg/imports/ufa.go	Fri Mar 20 12:28:04 2020 +0100
+++ b/pkg/imports/ufa.go	Fri Mar 20 17:24:03 2020 +0100
@@ -51,6 +51,7 @@
 
 func (ufaJobCreator) AutoAccept() bool { return true }
 
+// StageDone is a NOP for fairway availability imports.
 func (ufaJobCreator) StageDone(context.Context, *sql.Tx, int64, Feedback) error {
 	return nil
 }
diff -r 59a99655f34d -r 56c589f7435d pkg/imports/ugm.go
--- a/pkg/imports/ugm.go	Fri Mar 20 12:28:04 2020 +0100
+++ b/pkg/imports/ugm.go	Fri Mar 20 17:24:03 2020 +0100
@@ -45,6 +45,7 @@
 
 func (ugmJobCreator) AutoAccept() bool { return true }
 
+// StageDone is a NOP for gauge measurements imports.
 func (ugmJobCreator) StageDone(context.Context, *sql.Tx, int64, Feedback) error { return nil }
 
 // CleanUp removes the temporary files from the filesystem.
diff -r 59a99655f34d -r 56c589f7435d pkg/imports/wp.go
--- a/pkg/imports/wp.go	Fri Mar 20 12:28:04 2020 +0100
+++ b/pkg/imports/wp.go	Fri Mar 20 17:24:03 2020 +0100
@@ -149,6 +149,7 @@
     relation = 'waterway.waterway_profiles'::regclass)`
 )
 
+// StageDone moves the imported waterway profiles out of the staging area.
 func (wpJobCreator) StageDone(
 	ctx context.Context,
 	tx *sql.Tx,