]>
Commit | Line | Data |
---|---|---|
15c0b25d AP |
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. | |
16 | package tfdiags |