From da319bafa8e8571a01f7b7a3b7791f516725352a Mon Sep 17 00:00:00 2001 From: Taylor Blau Date: Fri, 11 Nov 2016 12:53:40 -0700 Subject: [PATCH] git/pw: :nail_care: documentation --- git/pkt_line_writer.go | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/git/pkt_line_writer.go b/git/pkt_line_writer.go index 71e647d5..dfebecee 100644 --- a/git/pkt_line_writer.go +++ b/git/pkt_line_writer.go @@ -44,10 +44,8 @@ func NewPktlineWriter(w io.Writer, c int) *PktlineWriter { // underlying stream of data, and the process repeats. // // When the caller has no more data to write in the given chunk of packets, a -// subsequent call to `Flush()` MUST be made in order to flush the remaining -// data in the buffer, and write the terminating bytes to the underlying packet -// stream. Alternatively, the caller can use the public `Flush() error` func to -// perform the same operation. +// subsequent call to `Flush()` SHOULD be made in order to signify that the +// current pkt sequence has terminated, and a new one can begin. // // Write returns the number of bytes in "p" accepted into the writer, which // _MAY_ be written to the underlying protocol stream, or may be written into