diff options
| author | Martin Atkins <mart@degeneration.co.uk> | 2019-09-10 15:31:59 -0700 |
|---|---|---|
| committer | Martin Atkins <mart@degeneration.co.uk> | 2019-10-01 15:59:10 -0700 |
| commit | 4755f8bf41cc3a022fded9eea3cb6b283cad3518 (patch) | |
| tree | 90734c7c91cba1e61ab47d0a003da0a9ecaee8f3 /json | |
| parent | 76cda0e2aaff7d4d018b170aaf6fbbb864073b25 (diff) | |
json: Clarify that this package is not interesting to import
Diffstat (limited to 'json')
| -rw-r--r-- | json/doc.go | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/json/doc.go b/json/doc.go index 4943f9b..84d7319 100644 --- a/json/doc.go +++ b/json/doc.go @@ -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 |
