fixup! terracost: add EstimateHCL function

cycloidio · May 27, 2021 · 24f522f · 24f522f
1 parent 68f1733
commit 24f522f
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/estimation.go b/estimation.go
@@ -47,6 +47,9 @@ func EstimateTerraformPlan(ctx context.Context, backend Backend, plan io.Reader,
 	return cost.NewPlan(prior, planned), nil
 }
 
+// EstimateHCL is a helper function that recursively reads Terraform modules from a directory at the
+// given path and generates a planned cost.State that is returned wrapped in a cost.Plan.
+// It uses the Backend to retrieve the pricing data.
 func EstimateHCL(ctx context.Context, backend Backend, fs afero.Fs, path string, providerInitializers ...terraform.ProviderInitializer) (*cost.Plan, error) {
 	if len(providerInitializers) == 0 {
 		providerInitializers = []terraform.ProviderInitializer{