Update function header to reflect current behavior

bnhassin · Sep 16, 2022 · 18fea49 · 18fea49
1 parent 6ab0d87
commit 18fea49
Showing 1 changed file with 5 additions and 3 deletions.
diff --git a/cmd/jujud/agent/machine/stateflag.go b/cmd/jujud/agent/machine/stateflag.go
@@ -10,10 +10,12 @@ import (
 	"github.com/juju/juju/cmd/jujud/agent/engine"
 )
 
-// isControllerFlagManifold returns a dependency.Manifold that requires state
-// config.
+// isControllerFlagManifold returns a dependency.Manifold that indicates
+// the state config is present or not depending on the arg.
 // It returns a worker implementing engine.Flag, whose Check method returns
-// whether state config is present on the machine.
+// True in 2 cases:
+// 1) state config is present on the machine and arg is True
+// 2) state config is not present on the machine and arg is False.
 func isControllerFlagManifold(yes bool) dependency.Manifold {
 	return dependency.Manifold{
 		Inputs: []string{stateConfigWatcherName},