configs: Additional guidance in doc.go

There's quite a lot in this package, so hopefully this additional
paragraph will help readers get oriented.
This commit is contained in:
Martin Atkins 2018-02-15 11:14:29 -08:00
parent 36fb5b52e7
commit c5f5340b15
1 changed files with 5 additions and 0 deletions

View File

@ -11,4 +11,9 @@
// of types from the HCL API, including raw HCL diagnostic messages. Such // of types from the HCL API, including raw HCL diagnostic messages. Such
// diagnostics can be converted into Terraform-flavored diagnostics, if needed, // diagnostics can be converted into Terraform-flavored diagnostics, if needed,
// using functions in the sibling package tfdiags. // 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 package configs