json: Clarify that this package is not interesting to import

This commit is contained in:
Martin Atkins 2019-09-10 15:31:59 -07:00
parent 76cda0e2aa
commit 4755f8bf41
1 changed files with 4 additions and 0 deletions

View File

@ -5,4 +5,8 @@
// This is not a generic JSON parser. Instead, it deals with the mapping from
// the JSON information model to the HCL information model, using a number
// of hard-coded structural conventions.
//
// In most cases applications will not import this package directly, but will
// instead access its functionality indirectly through functions in the main
// "hcl" package and in the "hclparse" package.
package json