this repo has no description
internal/core/debug: document Config fields
Signed-off-by: Daniel Martí <mvdan@mvdan.cc>
Change-Id: If8650d7e1275f9f48870a8ed4e98685ea5b83397
Reviewed-on: https://review.gerrithub.io/c/cue-lang/cue/+/1236173
TryBot-Result: CUEcueckoo <cueckoo@cuelang.org>
Unity-Result: CUE porcuepine <cue.porcuepine@gmail.com>
Reviewed-by: Marcel van Lohuizen <mpvl@gmail.com>
+16
-5
+16
-5
internal/core/debug/debug.go
+16
-5
internal/core/debug/debug.go
···
35
35
closeTuple = "\u3009"
36
36
)
37
37
38
+
// Config configures how [AppendNode] and [NodeString] render an ADT node.
39
+
// A nil *Config is treated as a zero-value Config.
38
40
type Config struct {
39
-
Cwd string
41
+
// Cwd is used to shorten file paths in rendered error messages,
42
+
// so that paths are printed relative to Cwd.
43
+
Cwd string
44
+
45
+
// Compact selects single-line output without indentation or newlines.
46
+
// Error arguments are always rendered compactly, regardless of this flag.
40
47
Compact bool
41
-
Raw bool
48
+
49
+
// Raw, when set in combination with Compact, prints a Vertex as the
50
+
// conjunction of its original conjuncts rather than its evaluated value,
51
+
// unless the Vertex already holds concrete data.
52
+
Raw bool
42
53
43
-
// ExpandLetExpr causes the expression of let reference to be printed.
44
-
// Note that this may result in large outputs. Use with care.
45
-
// Only applies if Compact is false.
54
+
// ExpandLetExpr causes the expression of a let reference to be printed
55
+
// inline after the reference. Note that this may result in large outputs;
56
+
// use with care. Only applies if Compact is false.
46
57
ExpandLetExpr bool
47
58
}
48
59