Adds comment on implementation details for the common provider Distri…

…buteInstances method.
MalloZup · Nov 27, 2018 · ec541d6 · ec541d6
1 parent 6fffa6f
commit ec541d6
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/provider/common/availabilityzones.go b/provider/common/availabilityzones.go
@@ -152,6 +152,10 @@ var internalAvailabilityZoneAllocations = AvailabilityZoneAllocations
 
 // DistributeInstances is a common function for implement the
 // state.InstanceDistributor policy based on availability zone spread.
+// TODO (manadart 2018-11-27) This method signature has grown to the point
+// where the argument list should be replaced with a struct.
+// At that time limitZones could be transformed to a map so that lookups in the
+// filtering below are more efficient.
 func DistributeInstances(
 	env ZonedEnviron, ctx context.ProviderCallContext, candidates, group []instance.Id, limitZones []string,
 ) ([]instance.Id, error) {