Update s2/writer.go

Co-authored-by: Klaus Post <klauspost@gmail.com>
klauspost · Feb 11, 2024 · 09a048f · 09a048f
1 parent 2c36775
commit 09a048f
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/s2/writer.go b/s2/writer.go
@@ -716,8 +716,8 @@ func (w *Writer) writeSync(p []byte) (nRet int, errRet error) {
 	return nRet, nil
 }
 
-// AsyncFlush writes any buffered bytes to a block, but does not flush it to the
-// underlying io.Writer.
+// AsyncFlush writes any buffered bytes to a block and starts compressing it.
+// It does not wait for the output has been written as Flush() does.
 func (w *Writer) AsyncFlush() error {
 	if err := w.err(nil); err != nil {
 		return err