fix some godoc comments, and add docs links

Use the "docs links" (`[<reference>]`) format so that the documentation generates links to the types referenced. Signed-off-by: Sebastiaan van Stijn <[email protected]>
tinylib · Dec 31, 2022 · 87d7486 · 87d7486
1 parent 15e1d85
commit 87d7486
Show file tree

Hide file tree

Showing 2 changed files with 78 additions and 78 deletions.
diff --git a/msgp/read.go b/msgp/read.go
@@ -395,7 +395,7 @@ func (m *Reader) ReadMapKey(scratch []byte) ([]byte, error) {
 	return out, nil
 }
 
-// MapKeyPtr returns a []byte pointing to the contents
+// ReadMapKeyPtr returns a []byte pointing to the contents
 // of a valid map key. The key cannot be empty, and it
 // must be shorter than the total buffer size of the
 // *Reader. Additionally, the returned slice is only