This is an automated email from the ASF dual-hosted git repository.
engelen pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/pekko.git
The following commit(s) were added to refs/heads/main by this push:
new f7eddaa1aa docs: stream operator throttle typo (#1348)
f7eddaa1aa is described below
commit f7eddaa1aabbb167963de3f9344eab2c6daf292f
Author: AndyChen(Jingzhang) <[email protected]>
AuthorDate: Wed May 29 01:49:59 2024 +0800
docs: stream operator throttle typo (#1348)
* docs: stream operator throttle typo
* more clarify
* Update docs/src/main/paradox/stream/operators/Source-or-Flow/throttle.md
* Update docs/src/main/paradox/stream/operators/Source-or-Flow/throttle.md
Co-authored-by: Arnout Engelen <[email protected]>
---------
Co-authored-by: Arnout Engelen <[email protected]>
---
docs/src/main/paradox/stream/operators/Source-or-Flow/throttle.md | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/docs/src/main/paradox/stream/operators/Source-or-Flow/throttle.md
b/docs/src/main/paradox/stream/operators/Source-or-Flow/throttle.md
index 38a1cfd57d..efc1a1ed39 100644
--- a/docs/src/main/paradox/stream/operators/Source-or-Flow/throttle.md
+++ b/docs/src/main/paradox/stream/operators/Source-or-Flow/throttle.md
@@ -21,7 +21,7 @@ See also @ref:[Buffers and working with
rate](../../stream-rate.md) for related
## Example
Imagine the server end of a streaming platform. When a client connects and
request a video content, the server
-should return the content. Instead of serving a complete video as fast as
bandwith allows, `throttle` can be used
+should return the content. Instead of serving a complete video as fast as
bandwidth allows, `throttle` can be used
to limit the network usage to 24 frames per second (let's imagine this
streaming platform stores frames, not bytes).
Scala
@@ -41,8 +41,8 @@ Scala
Java
: @@snip
[Throttle.java](/docs/src/test/java/jdocs/stream/operators/sourceorflow/Throttle.java)
{ #throttle-with-burst }
-The extra argument to set the `ThrottleMode` to `shaping` tells `throttle` to
make pauses to avoid exceeding
-the maximum rate. Alternatively we could set the throttling mode to cause a
stream failure when upstream is faster
+The extra argument to set the `ThrottleMode` to `shaping` tells throttle to
make pauses to avoid exceeding
+the maximum rate. Alternatively we could set the `ThrottleMode` to `enforcing`
to cause a stream failure when upstream is faster
than the throttle rate.
The examples above don't cover all the parameters supported by `throttle`
(e.g. `cost`-based throttling). See the
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
