raboof commented on code in PR #2409:
URL: https://github.com/apache/pekko/pull/2409#discussion_r2576985405


##########
docs/src/main/paradox/stream/operators/Compression/zstd.md:
##########
@@ -0,0 +1,30 @@
+# Compression.zstd
+
+Creates a flow that zstd-compresses a stream of ByteStrings.
+
+@ref[Compression operators](../index.md#compression-operators)
+
+## Signature
+
+@apidoc[Compression.zstd](stream.*.Compression$) { 
scala="#zstd:org.apache.pekko.stream.scaladsl.Flow[org.apache.pekko.util.ByteString,org.apache.pekko.util.ByteString,org.apache.pekko.NotUsed]"
 java="#zstd()" }
+
+## Description
+
+Creates a flow that zstd-compresses a stream of ByteStrings. Note that the 
compressor
+will SYNC_FLUSH after every @apidoc[util.ByteString] so that it is guaranteed 
that every @apidoc[util.ByteString]

Review Comment:
   That is correct. I wasn't trying to say the original comment is wrong (it 
isn't), I meant to say that it would be valuable to highlight that the way the 
incoming data is split up influences the result of the compression.



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]


---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to