aboutsummaryrefslogtreecommitdiffhomepage
path: root/vendor/github.com/hashicorp/terraform/tfdiags/doc.go
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/github.com/hashicorp/terraform/tfdiags/doc.go')
-rw-r--r--vendor/github.com/hashicorp/terraform/tfdiags/doc.go16
1 files changed, 16 insertions, 0 deletions
diff --git a/vendor/github.com/hashicorp/terraform/tfdiags/doc.go b/vendor/github.com/hashicorp/terraform/tfdiags/doc.go
new file mode 100644
index 0000000..c427879
--- /dev/null
+++ b/vendor/github.com/hashicorp/terraform/tfdiags/doc.go
@@ -0,0 +1,16 @@
1// Package tfdiags is a utility package for representing errors and
2// warnings in a manner that allows us to produce good messages for the
3// user.
4//
5// "diag" is short for "diagnostics", and is meant as a general word for
6// feedback to a user about potential or actual problems.
7//
8// A design goal for this package is for it to be able to provide rich
9// messaging where possible but to also be pragmatic about dealing with
10// generic errors produced by system components that _can't_ provide
11// such rich messaging. As a consequence, the main types in this package --
12// Diagnostics and Diagnostic -- are designed so that they can be "smuggled"
13// over an error channel and then be unpacked at the other end, so that
14// error diagnostics (at least) can transit through APIs that are not
15// aware of this package.
16package tfdiags