This is an automated email from the ASF dual-hosted git repository.
He-Pin 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 0f74543359 docs: fix markup that breaks page rendering (#3579)
0f74543359 is described below
commit 0f7454335900d33e5ae3487e28ce579c2277da5f
Author: PJ Fanning <[email protected]>
AuthorDate: Fri Oct 9 05:27:57 2026 +0100
docs: fix markup that breaks page rendering (#3579)
* docs: fix markup that breaks page rendering
Motivation:
Several doc pages render incorrectly because of markup errors: an
unclosed warning block, swapped language wrappers, an escaped
directive, mangled module names and an over-indented code fence.
Modification:
- typed/distributed-pub-sub.md: restore the pekko-actor-typed,
pekko-bom and pekko-cluster-typed names in the module info and
dependency block
- actors.md: close the Dependency Injection warning block, which was
swallowing the "Actor API" section and everything after it; use
@java[ for the Java future callbacks and @scala[ for the Scala
setReceiveTimeout link
- persistence.md: fix the escaped persist/persistAll language switch and
repair the mangled SnapshotSelectionCriteria link
- mailboxes.md: fix the unbalanced parenthesis in the Java example and
use withMailbox instead of withDispatcher in both examples
- multi-jvm-testing.md: indent the build.sbt code fence so it renders
as a code block in the list item
Result:
The affected pages render as intended.
Tests:
- sbt docs/paradox
References:
None - found during a review of the docs
* docs: align Java mailbox example method name with Scala
Motivation:
The Java custom mailbox example calls getLastEnqueued() while the
Scala example calls getLastEnqueuedMessage. #3588 skipped this line
because it is next to a line this PR changes.
Modification:
Use getLastEnqueuedMessage() in the Java example.
Result:
Both examples use the same method name.
Tests:
- Not run - docs only
References:
Refs #3588
---
docs/src/main/paradox/actors.md | 6 ++++--
docs/src/main/paradox/mailboxes.md | 6 +++---
docs/src/main/paradox/multi-jvm-testing.md | 10 +++++-----
docs/src/main/paradox/persistence.md | 4 ++--
docs/src/main/paradox/typed/distributed-pub-sub.md | 6 +++---
5 files changed, 17 insertions(+), 15 deletions(-)
diff --git a/docs/src/main/paradox/actors.md b/docs/src/main/paradox/actors.md
index fff471c1ac..eecbe208a1 100644
--- a/docs/src/main/paradox/actors.md
+++ b/docs/src/main/paradox/actors.md
@@ -293,6 +293,8 @@ described here: @ref:[What Restarting
Means](general/supervision.md#supervision-
When using a dependency injection framework, actor beans *MUST NOT* have
singleton scope.
+@@@
+
## Actor API
@scala[The @apidoc[actor.Actor] trait defines only one abstract method, the
above mentioned
@@ -747,7 +749,7 @@ you a way to avoid blocking.
@@@ warning
-When using future callbacks, @scala[such as
@scaladoc[onComplete](scala.concurrent.Future#onComplete[U](f:scala.util.Try[T]=%3EU)(implicitexecutor:scala.concurrent.ExecutionContext):Unit),
or
@scaladoc[map](scala.concurrent.Future#map[S](f:T=%3ES)(implicitexecutor:scala.concurrent.ExecutionContext):scala.concurrent.Future[S])]@scala[such
as
@javadoc[thenRun](java.util.concurrent.CompletionStage#thenRun(java.lang.Runnable)),
or @javadoc[thenApply](java.util.concurrent.CompletionStage#then [...]
+When using future callbacks, @scala[such as
@scaladoc[onComplete](scala.concurrent.Future#onComplete[U](f:scala.util.Try[T]=%3EU)(implicitexecutor:scala.concurrent.ExecutionContext):Unit),
or
@scaladoc[map](scala.concurrent.Future#map[S](f:T=%3ES)(implicitexecutor:scala.concurrent.ExecutionContext):scala.concurrent.Future[S])]@java[such
as
@javadoc[thenRun](java.util.concurrent.CompletionStage#thenRun(java.lang.Runnable)),
or @javadoc[thenApply](java.util.concurrent.CompletionStage#thenA [...]
inside actors you need to carefully avoid closing over
the containing actor’s reference, i.e. do not call methods or access mutable
state
on the enclosing actor from within the callback. This would break the actor
@@ -866,7 +868,7 @@ Java
## Receive timeout
-The
@java[@scaladoc[ActorContext.setReceiveTimeout](pekko.actor.ActorContext#setReceiveTimeout(timeout:scala.concurrent.duration.Duration):Unit)]@java[@javadoc[ActorContext.setReceiveTimeout](pekko.actor.AbstractActor.ActorContext#setReceiveTimeout(java.time.Duration))]
defines the inactivity timeout after which
+The
@scala[@scaladoc[ActorContext.setReceiveTimeout](pekko.actor.ActorContext#setReceiveTimeout(timeout:scala.concurrent.duration.Duration):Unit)]@java[@javadoc[ActorContext.setReceiveTimeout](pekko.actor.AbstractActor.ActorContext#setReceiveTimeout(java.time.Duration))]
defines the inactivity timeout after which
the sending of a @apidoc[actor.ReceiveTimeout] message is triggered.
When specified, the receive function should be able to handle an
`org.apache.pekko.actor.ReceiveTimeout` message.
1 millisecond is the minimum supported timeout.
diff --git a/docs/src/main/paradox/mailboxes.md
b/docs/src/main/paradox/mailboxes.md
index a705f79b64..89c8be585e 100644
--- a/docs/src/main/paradox/mailboxes.md
+++ b/docs/src/main/paradox/mailboxes.md
@@ -198,7 +198,7 @@ Scala
```scala
val props: Props = ...
// this actor uses MyCustomMailbox, which is assumed to be a singleton
- system.actorOf(props.withDispatcher("myCustomMailbox")) ! "bang"
+ system.actorOf(props.withMailbox("myCustomMailbox")) ! "bang"
assert(MyCustomMailbox.instance.getLastEnqueuedMessage == "bang")
```
@@@
@@ -208,8 +208,8 @@ Java
```java
final Props props = ...
// this actor uses MyCustomMailbox, which is assumed to be a singleton
- system.actorOf(props.withDispatcher("myCustomMailbox").tell("bang",
sender);
- assert(MyCustomMailbox.getInstance().getLastEnqueued().equals("bang"));
+ system.actorOf(props.withMailbox("myCustomMailbox")).tell("bang", sender);
+
assert(MyCustomMailbox.getInstance().getLastEnqueuedMessage().equals("bang"));
```
@@@
diff --git a/docs/src/main/paradox/multi-jvm-testing.md
b/docs/src/main/paradox/multi-jvm-testing.md
index db7a55fe0e..e4d04165cb 100644
--- a/docs/src/main/paradox/multi-jvm-testing.md
+++ b/docs/src/main/paradox/multi-jvm-testing.md
@@ -21,11 +21,11 @@ To configure it in your project you should do the following
steps:
2. Add multi-JVM testing to `build.sbt` or `project/Build.scala` by enabling
`MultiJvmPlugin` and
setting the `MultiJvm` config.
- ```none
- lazy val root = (project in file("."))
- .enablePlugins(MultiJvmPlugin)
- .configs(MultiJvm)
- ```
+ ```none
+ lazy val root = (project in file("."))
+ .enablePlugins(MultiJvmPlugin)
+ .configs(MultiJvm)
+ ```
**Please note** that by default MultiJvm test sources are located in
`src/multi-jvm/...`,
and not in `src/test/...`.
diff --git a/docs/src/main/paradox/persistence.md
b/docs/src/main/paradox/persistence.md
index 9629d1bde2..13572d38e1 100644
--- a/docs/src/main/paradox/persistence.md
+++ b/docs/src/main/paradox/persistence.md
@@ -225,7 +225,7 @@ is called (logging the error by default) and the actor will
be stopped.
### Internal stash
The persistent actor has a private @ref:[stash](actors.md#stash) for
internally caching incoming messages during
-[recovery](#recovery) or the
@scala[@scaladoc[persist](pekko.persistence.PersistentActor#persist[A](event:A)(handler:A=%3EUnit):Unit)]@java[@javadoc[persist](pekko.persistence.AbstractPersistentActorLike#persist(A,org.apache.pekko.japi.Procedure))]\@scala[@scaladoc[persistAll](pekko.persistence.PersistentActor#persistAll[A](events:Seq[A])(handler:A=%3EUnit):Unit)]@java[@javadoc[persistAll](pekko.persistence.AbstractPersistentActorLike#persistAll(java.lang.Iterable,org.apache.pekko.japi.P
[...]
+[recovery](#recovery) or the
@scala[@scaladoc[persist](pekko.persistence.PersistentActor#persist[A](event:A)(handler:A=%3EUnit):Unit)]@java[@javadoc[persist](pekko.persistence.AbstractPersistentActorLike#persist(A,org.apache.pekko.japi.Procedure))]@scala[
or
@scaladoc[persistAll](pekko.persistence.PersistentActor#persistAll[A](events:Seq[A])(handler:A=%3EUnit):Unit)]@java[
or
@javadoc[persistAll](pekko.persistence.AbstractPersistentActorLike#persistAll(java.lang.Iterable,org.apache.pekko
[...]
@apidoc[actor.Stash] interface. The internal stash cooperates with the normal
stash by hooking into @apidoc[unstashAll](actor.Stash)
{scala="#unstashAll():Unit" java="#unstashAll()"}
making sure messages are unstashed properly to the internal stash to maintain
ordering guarantees.
@@ -634,7 +634,7 @@ Note that the "persistence mode" of @ref:[Cluster
Sharding](cluster-sharding.md)
A persistent actor can delete individual snapshots by calling the
@apidoc[deleteSnapshot](persistence.Snapshotter)
{scala="#deleteSnapshot(sequenceNr:Long):Unit" java="#deleteSnapshot(long)"}
method with the sequence number of
when the snapshot was taken.
-To bulk-delete a range of snapshots matching
scala/org/apache/pekko/persistence.SnapshotSelectionCriteria],
+To bulk-delete a range of snapshots matching
@apidoc[persistence.SnapshotSelectionCriteria],
persistent actors should use the
@apidoc[deleteSnapshots](persistence.Snapshotter)
{scala="#deleteSnapshots(criteria:org.apache.pekko.persistence.SnapshotSelectionCriteria):Unit"
java="#deleteSnapshots(org.apache.pekko.persistence.SnapshotSelectionCriteria)"}
method. Depending on the journal used this might be inefficient. It is
best practice to do specific deletes with `deleteSnapshot` or to include a
`minSequenceNr` as well as a `maxSequenceNr`
for the `SnapshotSelectionCriteria`.
diff --git a/docs/src/main/paradox/typed/distributed-pub-sub.md
b/docs/src/main/paradox/typed/distributed-pub-sub.md
index fc6bd5f2fc..ebe14429bb 100644
--- a/docs/src/main/paradox/typed/distributed-pub-sub.md
+++ b/docs/src/main/paradox/typed/distributed-pub-sub.md
@@ -4,15 +4,15 @@ You are viewing the documentation for the new actor APIs, to
view the Pekko Clas
## Module info
-The distributed publish subscribe topic API is available and usable with the
core `(/actor-typed` module, however it will only be distributed
+The distributed publish subscribe topic API is available and usable with the
core `pekko-actor-typed` module, however it will only be distributed
when used in a clustered application:
@@dependency[sbt,Maven,Gradle] {
- bomGroup=org.apache.pekko bomArtifact=(/bom_$scala.binary.version$
bomVersionSymbols=PekkoVersion
+ bomGroup=org.apache.pekko bomArtifact=pekko-bom_$scala.binary.version$
bomVersionSymbols=PekkoVersion
symbol1=PekkoVersion
value1="$pekko.version$"
group="org.apache.pekko"
- artifact="(/cluster-typed_$scala.binary.version$"
+ artifact="pekko-cluster-typed_$scala.binary.version$"
version=PekkoVersion
}
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
