chore: improve method documentation

christiangda · christiangda · commit bcefa6a66b36 · 2022-05-29T19:33:47.000+02:00
diff --git a/mapkeyvalue.go b/mapkeyvalue.go
@@ -65,6 +65,7 @@ func (r *MapKeyValue[K, T]) GetAndCheck(key K) (T, bool) {
 }
 
 // Get returns the value associated with the key.
+// If the key does not exist, return zero value of the type.
 func (r *MapKeyValue[K, T]) Get(key K) T {
 	r.mu.RLock()
 	defer r.mu.RUnlock()

Original file line number	Diff line number	Diff line change
`@@ -65,6 +65,7 @@ func (r *MapKeyValue[K, T]) GetAndCheck(key K) (T, bool) {`
`65`	`65`	`}`
`66`	`66`
`67`	`67`	`// Get returns the value associated with the key.`
	`68`	`+// If the key does not exist, return zero value of the type.`
`68`	`69`	`func (r *MapKeyValue[K, T]) Get(key K) T {`
`69`	`70`	`r.mu.RLock()`
`70`	`71`	`defer r.mu.RUnlock()`