common: improve documentation of Hash.SetBytes (#15062)

holiman · fjl · commit fc87bc5f523a · 2017-09-07T23:32:59.000+02:00
Fixes #15004
diff --git a/common/types.go b/common/types.go
@@ -88,7 +88,7 @@ func (h Hash) MarshalText() ([]byte, error) {
 	return hexutil.Bytes(h[:]).MarshalText()
 }
 
-// Sets the hash to the value of b. If b is larger than len(h) it will panic
+// Sets the hash to the value of b. If b is larger than len(h), 'b' will be cropped (from the left).
 func (h *Hash) SetBytes(b []byte) {
 	if len(b) > len(h) {
 		b = b[len(b)-HashLength:]
@@ -97,7 +97,7 @@ func (h *Hash) SetBytes(b []byte) {
 	copy(h[HashLength-len(b):], b)
 }
 
-// Set string `s` to h. If s is larger than len(h) it will panic
+// Set string `s` to h. If s is larger than len(h) s will be cropped (from left) to fit.
 func (h *Hash) SetString(s string) { h.SetBytes([]byte(s)) }
 
 // Sets h to other

Original file line number	Diff line number	Diff line change
`@@ -88,7 +88,7 @@ func (h Hash) MarshalText() ([]byte, error) {`
`88`	`88`	`return hexutil.Bytes(h[:]).MarshalText()`
`89`	`89`	`}`
`90`	`90`
`91`		`-// Sets the hash to the value of b. If b is larger than len(h) it will panic`
	`91`	`+// Sets the hash to the value of b. If b is larger than len(h), 'b' will be cropped (from the left).`
`92`	`92`	`func (h *Hash) SetBytes(b []byte) {`
`93`	`93`	`if len(b) > len(h) {`
`94`	`94`	`b = b[len(b)-HashLength:]`
`@@ -97,7 +97,7 @@ func (h *Hash) SetBytes(b []byte) {`
`97`	`97`	`copy(h[HashLength-len(b):], b)`
`98`	`98`	`}`
`99`	`99`
`100`		-// Set string `s` to h. If s is larger than len(h) it will panic
	`100`	+// Set string `s` to h. If s is larger than len(h) s will be cropped (from left) to fit.
`101`	`101`	`func (h *Hash) SetString(s string) { h.SetBytes([]byte(s)) }`
`102`	`102`
`103`	`103`	`// Sets h to other`