Merge pull request #226 from ifraixedes/if/fix-doc-map-method

tidwall · web-flow · commit 5827eb3b24ec · 2021-09-01T07:27:29.000-07:00
Fix Map method documentation
diff --git a/gjson.go b/gjson.go
@@ -283,7 +283,8 @@ func (t Result) ForEach(iterator func(key, value Result) bool) {
 	}
 }
 
-// Map returns back an map of values. The result should be a JSON array.
+// Map returns back a map of values. The result should be a JSON object.
+// If the result is not a JSON object, the return value will be an empty map.
 func (t Result) Map() map[string]Result {
 	if t.Type != JSON {
 		return map[string]Result{}

Original file line number	Diff line number	Diff line change
`@@ -283,7 +283,8 @@ func (t Result) ForEach(iterator func(key, value Result) bool) {`
`283`	`283`	`}`
`284`	`284`	`}`
`285`	`285`
`286`		`-// Map returns back an map of values. The result should be a JSON array.`
	`286`	`+// Map returns back a map of values. The result should be a JSON object.`
	`287`	`+// If the result is not a JSON object, the return value will be an empty map.`
`287`	`288`	`func (t Result) Map() map[string]Result {`
`288`	`289`	`if t.Type != JSON {`
`289`	`290`	`return map[string]Result{}`