packfile: add comment on GetSizeByOffset

strib · strib · commit 6faf286b97ff · 2018-10-15T10:20:38.000-07:00
Suggested by mcuadros. Issue: #982 Signed-off-by: Jeremy Stribling <strib@alum.mit.edu>
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) {

Original file line number	Diff line number	Diff line change
`@@ -90,6 +90,8 @@ func (p *Packfile) GetByOffset(o int64) (plumbing.EncodedObject, error) {`
`90`	`90`	`return p.nextObject()`
`91`	`91`	`}`
`92`	`92`
	`93`	`+// GetSizeByOffset retrieves the size of the encoded object from the`
	`94`	`+// packfile with the given offset.`
`93`	`95`	`func (p *Packfile) GetSizeByOffset(o int64) (size int64, err error) {`
`94`	`96`	`if _, err := p.s.SeekFromStart(o); err != nil {`
`95`	`97`	`if err == io.EOF \|\| isInvalid(err) {`