packfile: add comment on GetSizeByOffset

Suggested by mcuadros. Issue: src-d#982 Signed-off-by: Jeremy Stribling <[email protected]>
jpeletier · Oct 15, 2018 · 6faf286 · 6faf286
1 parent b3a3f0a
commit 6faf286
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/plumbing/format/packfile/packfile.go b/plumbing/format/packfile/packfile.go
@@ -90,6 +90,8 @@ func (p *Packfile) GetByOffset(o int64) (plumbing.EncodedObject, error) {
 	return p.nextObject()
 }
 
+// GetSizeByOffset retrieves the size of the encoded object from the
+// packfile with the given offset.
 func (p *Packfile) GetSizeByOffset(o int64) (size int64, err error) {
 	if _, err := p.s.SeekFromStart(o); err != nil {
 		if err == io.EOF || isInvalid(err) {