From c5f5340b151a544bd9d335778b259e5e2f60c99f Mon Sep 17 00:00:00 2001 From: Martin Atkins Date: Thu, 15 Feb 2018 11:14:29 -0800 Subject: [PATCH] configs: Additional guidance in doc.go There's quite a lot in this package, so hopefully this additional paragraph will help readers get oriented. --- configs/doc.go | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/configs/doc.go b/configs/doc.go index 9688b36cd..f01eb79f4 100644 --- a/configs/doc.go +++ b/configs/doc.go @@ -11,4 +11,9 @@ // of types from the HCL API, including raw HCL diagnostic messages. Such // diagnostics can be converted into Terraform-flavored diagnostics, if needed, // using functions in the sibling package tfdiags. +// +// The Parser type is the main entry-point into this package. The LoadConfigDir +// method can be used to load a single module directory, and then a full +// configuration (including any descendent modules) can be produced using +// the top-level BuildConfig method. package configs