Document behaviour of squash when decoding struct->map

mitchellh · Dec 22, 2020 · 35a4b15 · 35a4b15
1 parent 9ed2c4b
commit 35a4b15
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/mapstructure.go b/mapstructure.go
@@ -72,6 +72,17 @@
 //         "name": "alice",
 //     }
 //
+// When decoding from a struct to a map, the squash tag squashes the struct
+// fields into a single map. Using the example structs from above:
+//
+//     Friend{Person: Person{Name: "alice"}}
+//
+// Will be decoded into a map:
+//
+//     map[string]interface{}{
+//         "name": "alice",
+//     }
+//
 // DecoderConfig has a field that changes the behavior of mapstructure
 // to always squash embedded structs.
 //