Skip to content
This repository was archived by the owner on Aug 23, 2023. It is now read-only.

Commit a473cff

Browse files
committed
improve FrameDecoder.Decode comment
1 parent 58da68a commit a473cff

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

recording.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,8 @@ func NewFrameDecoder(r io.Reader) (*FrameDecoder, error) {
3131
return fd, nil
3232
}
3333

34-
// Decode retrieves the next frame from the input stream. If the input is at
35-
// EOF, it returns the error io.EOF.
34+
// Decode retrieves the next frame from the input stream. The frame pointer
35+
// should be non nil. If the input is at EOF, it returns the error io.EOF.
3636
func (fd *FrameDecoder) Decode(framep *Frame) error {
3737
if framep == nil {
3838
return errors.New("frame decoding: attempt to decode into nil pointer")

0 commit comments

Comments
 (0)