This is an automated email from the ASF dual-hosted git repository.
hepin pushed a commit to branch 1.0.x
in repository https://gitbox.apache.org/repos/asf/incubator-pekko.git
The following commit(s) were added to refs/heads/1.0.x by this push:
new 9b0b6d63e0 some doc changes (#1177) (#1200)
9b0b6d63e0 is described below
commit 9b0b6d63e03a4534ec60d708fb5e96fce3d1591a
Author: PJ Fanning <[email protected]>
AuthorDate: Sun Mar 17 08:35:08 2024 +0100
some doc changes (#1177) (#1200)
---
.../testkit/typed/internal/ActorSystemStub.scala | 2 +-
docs/src/main/paradox/release-notes/index.md | 2 +-
.../stream/scaladsl/FlowFlatMapPrefixSpec.scala | 2 +-
.../pekko/stream/scaladsl/FlowFutureFlowSpec.scala | 4 ++--
.../pekko/stream/scaladsl/LazyFlowSpec.scala | 2 +-
.../scala/org/apache/pekko/stream/Attributes.scala | 2 +-
.../org/apache/pekko/stream/javadsl/Flow.scala | 2 +-
.../pekko/stream/javadsl/FlowWithContext.scala | 2 +-
.../org/apache/pekko/stream/javadsl/Source.scala | 2 +-
.../pekko/stream/javadsl/SourceWithContext.scala | 2 +-
.../org/apache/pekko/stream/scaladsl/Flow.scala | 26 +++++++++++-----------
.../pekko/stream/scaladsl/FlowWithContextOps.scala | 4 ++--
12 files changed, 26 insertions(+), 26 deletions(-)
diff --git
a/actor-testkit-typed/src/main/scala/org/apache/pekko/actor/testkit/typed/internal/ActorSystemStub.scala
b/actor-testkit-typed/src/main/scala/org/apache/pekko/actor/testkit/typed/internal/ActorSystemStub.scala
index 388f74e323..db553b9266 100644
---
a/actor-testkit-typed/src/main/scala/org/apache/pekko/actor/testkit/typed/internal/ActorSystemStub.scala
+++
b/actor-testkit-typed/src/main/scala/org/apache/pekko/actor/testkit/typed/internal/ActorSystemStub.scala
@@ -137,7 +137,7 @@ import pekko.util.FutureConverters
@InternalApi private[pekko] object ActorSystemStub {
object config {
- // this is backward compatible with the old behaviour, hence it uses the
loader used to load the test-kit
+ // this is backward compatible with the old behavior, hence it uses the
loader used to load the test-kit
// which is not necessarily the one used to load the tests...
// hence this might not include reference config related to the actually
executing test
// todo: might be better NOT to pass any class loader and let
typesafeConfig rely on the contextClassLoader
diff --git a/docs/src/main/paradox/release-notes/index.md
b/docs/src/main/paradox/release-notes/index.md
index 1c74b7aff4..8826580541 100644
--- a/docs/src/main/paradox/release-notes/index.md
+++ b/docs/src/main/paradox/release-notes/index.md
@@ -12,7 +12,7 @@ This is milestone release and is aimed at testing some new
support for users who
* Change the manager name to use `pekko` in the name
([PR587](https://github.com/apache/incubator-pekko/pull/587))
* Support interacting with Akka Remote and Cluster nodes
([PR765](https://github.com/apache/incubator-pekko/pull/765),
[PR1112](https://github.com/apache/incubator-pekko/pull/1112))
- * See the [wiki
notes](https://cwiki.apache.org/confluence/display/PEKKO/Pekko+Akka+Compatibility)
about uptaking this
+ * See the [wiki
notes](https://cwiki.apache.org/confluence/display/PEKKO/Pekko+Akka+Compatibility)
about uptaking this
* Change noisy logging in DNS handler
([PR835](https://github.com/apache/incubator-pekko/pull/835))
* Support reading akka-persistence snapshots
([PR837](https://github.com/apache/incubator-pekko/pull/837),
[PR841](https://github.com/apache/incubator-pekko/pull/841))
* Fix deprecation version on GraphApply
([PR877](https://github.com/apache/incubator-pekko/pull/877))
diff --git
a/stream-tests/src/test/scala/org/apache/pekko/stream/scaladsl/FlowFlatMapPrefixSpec.scala
b/stream-tests/src/test/scala/org/apache/pekko/stream/scaladsl/FlowFlatMapPrefixSpec.scala
index 325824df64..e4aad06d15 100644
---
a/stream-tests/src/test/scala/org/apache/pekko/stream/scaladsl/FlowFlatMapPrefixSpec.scala
+++
b/stream-tests/src/test/scala/org/apache/pekko/stream/scaladsl/FlowFlatMapPrefixSpec.scala
@@ -714,7 +714,7 @@ class FlowFlatMapPrefixSpec extends
StreamSpec("pekko.loglevel = debug") {
}
}
def withAttr[A] = Flow.fromGraph(new WithAttr[A])
- "baseline behaviour" in {
+ "baseline behavior" in {
Source
.single("1")
.via(withAttr)
diff --git
a/stream-tests/src/test/scala/org/apache/pekko/stream/scaladsl/FlowFutureFlowSpec.scala
b/stream-tests/src/test/scala/org/apache/pekko/stream/scaladsl/FlowFutureFlowSpec.scala
index 3f6423251b..85fd6b6bd6 100644
---
a/stream-tests/src/test/scala/org/apache/pekko/stream/scaladsl/FlowFutureFlowSpec.scala
+++
b/stream-tests/src/test/scala/org/apache/pekko/stream/scaladsl/FlowFutureFlowSpec.scala
@@ -29,9 +29,9 @@ class FlowFutureFlowSpec extends StreamSpec {
case x => x
}
- // this stage's behaviour in case of an 'early' downstream cancellation is
governed by an attribute
+ // this stage's behavior in case of an 'early' downstream cancellation is
governed by an attribute
// so we run all tests cases using both modes of the attributes.
- // please notice most of the cases don't exhibit any difference in behaviour
between the two modes
+ // please notice most of the cases don't exhibit any difference in behavior
between the two modes
for {
(att, name) <- List(
(Attributes.NestedMaterializationCancellationPolicy.EagerCancellation,
"EagerCancellation"),
diff --git
a/stream-tests/src/test/scala/org/apache/pekko/stream/scaladsl/LazyFlowSpec.scala
b/stream-tests/src/test/scala/org/apache/pekko/stream/scaladsl/LazyFlowSpec.scala
index bd8922dae6..02f4333900 100644
---
a/stream-tests/src/test/scala/org/apache/pekko/stream/scaladsl/LazyFlowSpec.scala
+++
b/stream-tests/src/test/scala/org/apache/pekko/stream/scaladsl/LazyFlowSpec.scala
@@ -227,7 +227,7 @@ class LazyFlowSpec extends StreamSpec("""
val deferredMatVal = result._1
val list = result._2
list.failed.futureValue shouldBe a[TE]
- // futureFlow's behaviour in case of mat failure (follows flatMapPrefix)
+ // futureFlow's behavior in case of mat failure (follows flatMapPrefix)
deferredMatVal.failed.futureValue shouldBe a[NeverMaterializedException]
deferredMatVal.failed.futureValue.getCause shouldEqual TE("mat-failed")
}
diff --git a/stream/src/main/scala/org/apache/pekko/stream/Attributes.scala
b/stream/src/main/scala/org/apache/pekko/stream/Attributes.scala
index 7539e95649..a547de5ab8 100644
--- a/stream/src/main/scala/org/apache/pekko/stream/Attributes.scala
+++ b/stream/src/main/scala/org/apache/pekko/stream/Attributes.scala
@@ -551,7 +551,7 @@ object Attributes {
/**
* Nested materialization cancellation strategy provides a way to configure
the cancellation behavior of stages that materialize a nested flow.
*
- * When cancelled before materializing their nested flows, these stages can
either immediately cancel (default behaviour) without materializing the nested
flow
+ * When cancelled before materializing their nested flows, these stages can
either immediately cancel (default behavior) without materializing the nested
flow
* or wait for the nested flow to materialize and then propagate the
cancellation signal through it.
*
* This applies to [[pekko.stream.scaladsl.FlowOps.flatMapPrefix]],
[[pekko.stream.scaladsl.Flow.futureFlow]] (and derivations such as
[[pekko.stream.scaladsl.Flow.lazyFutureFlow]]).
diff --git a/stream/src/main/scala/org/apache/pekko/stream/javadsl/Flow.scala
b/stream/src/main/scala/org/apache/pekko/stream/javadsl/Flow.scala
index d191384630..a406424ca7 100755
--- a/stream/src/main/scala/org/apache/pekko/stream/javadsl/Flow.scala
+++ b/stream/src/main/scala/org/apache/pekko/stream/javadsl/Flow.scala
@@ -904,7 +904,7 @@ final class Flow[In, Out, Mat](delegate: scaladsl.Flow[In,
Out, Mat]) extends Gr
*
* Parallelism limits the number of how many asks can be "in flight" at the
same time.
* Please note that the elements emitted by this operator are in-order with
regards to the asks being issued
- * (i.e. same behaviour as mapAsync).
+ * (i.e. same behavior as mapAsync).
*
* The operator fails with an
[[pekko.stream.WatchedActorTerminatedException]] if the target actor is
terminated.
*
diff --git
a/stream/src/main/scala/org/apache/pekko/stream/javadsl/FlowWithContext.scala
b/stream/src/main/scala/org/apache/pekko/stream/javadsl/FlowWithContext.scala
index fdcabc8980..0aedf868b1 100644
---
a/stream/src/main/scala/org/apache/pekko/stream/javadsl/FlowWithContext.scala
+++
b/stream/src/main/scala/org/apache/pekko/stream/javadsl/FlowWithContext.scala
@@ -57,7 +57,7 @@ final class FlowWithContext[In, CtxIn, Out, CtxOut, +Mat](
* Transform this flow by the regular flow. The given flow must support
manual context propagation by
* taking and producing tuples of (data, context).
*
- * It is up to the implementer to ensure the inner flow does not exhibit
any behaviour that is not expected
+ * It is up to the implementer to ensure the inner flow does not exhibit
any behavior that is not expected
* by the downstream elements, such as reordering. For more background on
these requirements
* see
https://pekko.apache.org/docs/pekko/current/stream/stream-context.html.
*
diff --git a/stream/src/main/scala/org/apache/pekko/stream/javadsl/Source.scala
b/stream/src/main/scala/org/apache/pekko/stream/javadsl/Source.scala
index 93a456f784..b3ac515ed8 100755
--- a/stream/src/main/scala/org/apache/pekko/stream/javadsl/Source.scala
+++ b/stream/src/main/scala/org/apache/pekko/stream/javadsl/Source.scala
@@ -2575,7 +2575,7 @@ final class Source[Out, Mat](delegate:
scaladsl.Source[Out, Mat]) extends Graph[
*
* Parallelism limits the number of how many asks can be "in flight" at the
same time.
* Please note that the elements emitted by this operator are in-order with
regards to the asks being issued
- * (i.e. same behaviour as mapAsync).
+ * (i.e. same behavior as mapAsync).
*
* The operator fails with an
[[pekko.stream.WatchedActorTerminatedException]] if the target actor is
terminated.
*
diff --git
a/stream/src/main/scala/org/apache/pekko/stream/javadsl/SourceWithContext.scala
b/stream/src/main/scala/org/apache/pekko/stream/javadsl/SourceWithContext.scala
index 90c6103443..14f047e8ce 100644
---
a/stream/src/main/scala/org/apache/pekko/stream/javadsl/SourceWithContext.scala
+++
b/stream/src/main/scala/org/apache/pekko/stream/javadsl/SourceWithContext.scala
@@ -55,7 +55,7 @@ final class SourceWithContext[+Out, +Ctx, +Mat](delegate:
scaladsl.SourceWithCon
* Transform this flow by the regular flow. The given flow must support
manual context propagation by
* taking and producing tuples of (data, context).
*
- * It is up to the implementer to ensure the inner flow does not exhibit
any behaviour that is not expected
+ * It is up to the implementer to ensure the inner flow does not exhibit
any behavior that is not expected
* by the downstream elements, such as reordering. For more background on
these requirements
* see
https://pekko.apache.org/docs/pekko/current/stream/stream-context.html.
*
diff --git a/stream/src/main/scala/org/apache/pekko/stream/scaladsl/Flow.scala
b/stream/src/main/scala/org/apache/pekko/stream/scaladsl/Flow.scala
index 1cfe93e2a3..3d94fa529e 100755
--- a/stream/src/main/scala/org/apache/pekko/stream/scaladsl/Flow.scala
+++ b/stream/src/main/scala/org/apache/pekko/stream/scaladsl/Flow.scala
@@ -608,8 +608,8 @@ object Flow {
*
* '''Cancels when''' downstream cancels (see below)
*
- * The operator's default behaviour in case of downstream cancellation
before nested flow materialization (future completion) is to cancel immediately.
- * This behaviour can be controlled by setting the
[[pekko.stream.Attributes.NestedMaterializationCancellationPolicy.PropagateToNested]]
attribute,
+ * The operator's default behavior in case of downstream cancellation before
nested flow materialization (future completion) is to cancel immediately.
+ * This behavior can be controlled by setting the
[[pekko.stream.Attributes.NestedMaterializationCancellationPolicy.PropagateToNested]]
attribute,
* this will delay downstream cancellation until nested flow's
materialization which is then immediately cancelled (with the original
cancellation cause).
*/
@deprecated(
@@ -640,8 +640,8 @@ object Flow {
*
* '''Cancels when''' downstream cancels (see below)
*
- * The operator's default behaviour in case of downstream cancellation
before nested flow materialization (future completion) is to cancel immediately.
- * This behaviour can be controlled by setting the
[[pekko.stream.Attributes.NestedMaterializationCancellationPolicy.PropagateToNested]]
attribute,
+ * The operator's default behavior in case of downstream cancellation before
nested flow materialization (future completion) is to cancel immediately.
+ * This behavior can be controlled by setting the
[[pekko.stream.Attributes.NestedMaterializationCancellationPolicy.PropagateToNested]]
attribute,
* this will delay downstream cancellation until nested flow's
materialization which is then immediately cancelled (with the original
cancellation cause).
*/
@deprecated("Use 'Flow.lazyFutureFlow' instead", "Akka 2.6.0")
@@ -658,8 +658,8 @@ object Flow {
* The materialized future value is completed with the materialized value of
the future flow or failed with a
* [[NeverMaterializedException]] if upstream fails or downstream cancels
before the future has completed.
*
- * The operator's default behaviour in case of downstream cancellation
before nested flow materialization (future completion) is to cancel immediately.
- * This behaviour can be controlled by setting the
[[pekko.stream.Attributes.NestedMaterializationCancellationPolicy.PropagateToNested]]
attribute,
+ * The operator's default behavior in case of downstream cancellation before
nested flow materialization (future completion) is to cancel immediately.
+ * This behavior can be controlled by setting the
[[pekko.stream.Attributes.NestedMaterializationCancellationPolicy.PropagateToNested]]
attribute,
* this will delay downstream cancellation until nested flow's
materialization which is then immediately cancelled (with the original
cancellation cause).
*/
def futureFlow[I, O, M](flow: Future[Flow[I, O, M]]): Flow[I, O, Future[M]] =
@@ -686,8 +686,8 @@ object Flow {
*
* '''Cancels when''' downstream cancels (see below)
*
- * The operator's default behaviour in case of downstream cancellation
before nested flow materialization (future completion) is to cancel immediately.
- * This behaviour can be controlled by setting the
[[pekko.stream.Attributes.NestedMaterializationCancellationPolicy.PropagateToNested]]
attribute,
+ * The operator's default behavior in case of downstream cancellation before
nested flow materialization (future completion) is to cancel immediately.
+ * This behavior can be controlled by setting the
[[pekko.stream.Attributes.NestedMaterializationCancellationPolicy.PropagateToNested]]
attribute,
* this will delay downstream cancellation until nested flow's
materialization which is then immediately cancelled (with the original
cancellation cause).
*/
def lazyFlow[I, O, M](create: () => Flow[I, O, M]): Flow[I, O, Future[M]] =
@@ -714,8 +714,8 @@ object Flow {
*
* '''Cancels when''' downstream cancels (see below)
*
- * The operator's default behaviour in case of downstream cancellation
before nested flow materialization (future completion) is to cancel immediately.
- * This behaviour can be controlled by setting the
[[pekko.stream.Attributes.NestedMaterializationCancellationPolicy.PropagateToNested]]
attribute,
+ * The operator's default behavior in case of downstream cancellation before
nested flow materialization (future completion) is to cancel immediately.
+ * This behavior can be controlled by setting the
[[pekko.stream.Attributes.NestedMaterializationCancellationPolicy.PropagateToNested]]
attribute,
* this will delay downstream cancellation until nested flow's
materialization which is then immediately cancelled (with the original
cancellation cause).
*/
def lazyFutureFlow[I, O, M](create: () => Future[Flow[I, O, M]]): Flow[I, O,
Future[M]] =
@@ -1182,7 +1182,7 @@ trait FlowOps[+Out, +Mat] {
*
* Parallelism limits the number of how many asks can be "in flight" at the
same time.
* Please note that the elements emitted by this operator are in-order with
regards to the asks being issued
- * (i.e. same behaviour as mapAsync).
+ * (i.e. same behavior as mapAsync).
*
* The operator fails with an
[[pekko.stream.WatchedActorTerminatedException]] if the target actor is
terminated,
* or with an [[java.util.concurrent.TimeoutException]] in case the ask
exceeds the timeout passed in.
@@ -2099,8 +2099,8 @@ trait FlowOps[+Out, +Mat] {
* the resulting flow will be materialized and signalled for upstream
completion, it can then complete or continue to emit elements at its own
discretion.
*
* '''Cancels when''' the materialized flow cancels.
- * When downstream cancels before materialization of the nested flow, the
operator's default behaviour is to cancel immediately,
- * this behaviour can be controlled by setting the
[[pekko.stream.Attributes.NestedMaterializationCancellationPolicy]] attribute
on the flow.
+ * When downstream cancels before materialization of the nested flow, the
operator's default behavior is to cancel immediately,
+ * this behavior can be controlled by setting the
[[pekko.stream.Attributes.NestedMaterializationCancellationPolicy]] attribute
on the flow.
* When this attribute is configured to true, downstream cancellation is
delayed until the nested flow's materialization which is then immediately
cancelled (with the original cancellation cause).
*
* @param n the number of elements to accumulate before materializing the
downstream flow.
diff --git
a/stream/src/main/scala/org/apache/pekko/stream/scaladsl/FlowWithContextOps.scala
b/stream/src/main/scala/org/apache/pekko/stream/scaladsl/FlowWithContextOps.scala
index 370f49e520..48d15ac8f4 100644
---
a/stream/src/main/scala/org/apache/pekko/stream/scaladsl/FlowWithContextOps.scala
+++
b/stream/src/main/scala/org/apache/pekko/stream/scaladsl/FlowWithContextOps.scala
@@ -42,7 +42,7 @@ trait FlowWithContextOps[+Out, +Ctx, +Mat] {
* Transform this flow by the regular flow. The given flow must support
manual context propagation by
* taking and producing tuples of (data, context).
*
- * It is up to the implementer to ensure the inner flow does not exhibit
any behaviour that is not expected
+ * It is up to the implementer to ensure the inner flow does not exhibit
any behavior that is not expected
* by the downstream elements, such as reordering. For more background on
these requirements
* see
https://pekko.apache.org/docs/pekko/current/stream/stream-context.html.
*
@@ -72,7 +72,7 @@ trait FlowWithContextOps[+Out, +Ctx, +Mat] {
* Transform this flow by the regular flow. The given flow must support
manual context propagation by
* taking and producing tuples of (data, context).
*
- * It is up to the implementer to ensure the inner flow does not exhibit
any behaviour that is not expected
+ * It is up to the implementer to ensure the inner flow does not exhibit
any behavior that is not expected
* by the downstream elements, such as reordering. For more background on
these requirements
* see
https://pekko.apache.org/docs/pekko/current/stream/stream-context.html.
*
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
