document the format used by WriteTypeAndValue

pierrre · Aug 5, 2024 · 5dae340 · 5dae340
1 parent 3264a4e
commit 5dae340
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/pretty.go b/pretty.go
@@ -160,6 +160,8 @@ func (c *Config) endRecursion(st *State) {
 }
 
 // WriteTypeAndValue writes the type and value to the writer.
+//
+// It writes "(TYPE) VALUE".
 func (c *Config) WriteTypeAndValue(w io.Writer, st *State, v reflect.Value) {
 	if !v.IsValid() {
 		WriteNil(w)