add comma to long sentence in docs (#452)

* add comma to long sentence in docs

* update to 'supervisee' based on review suggestion
This commit is contained in:
PJ Fanning 2023-06-23 15:13:00 +01:00 committed by GitHub
parent 2f8ef56626
commit b51ac9c2a4
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -117,7 +117,7 @@ It is possible to override this so that child actors are not influenced when the
The restarted parent instance will then have the same children as before the failure. The restarted parent instance will then have the same children as before the failure.
If child actors are created from @apidoc[setup](typed.*.Behaviors$) {scala="#setup[T](factory:org.apache.pekko.actor.typed.scaladsl.ActorContext[T]=%3Eorg.apache.pekko.actor.typed.Behavior[T]):org.apache.pekko.actor.typed.Behavior[T]" java="#setup(org.apache.pekko.japi.function.Function)"} like in the previous example and they should remain intact (not stopped) If child actors are created from @apidoc[setup](typed.*.Behaviors$) {scala="#setup[T](factory:org.apache.pekko.actor.typed.scaladsl.ActorContext[T]=%3Eorg.apache.pekko.actor.typed.Behavior[T]):org.apache.pekko.actor.typed.Behavior[T]" java="#setup(org.apache.pekko.japi.function.Function)"} like in the previous example and they should remain intact (not stopped)
when parent is restarted the @apidoc[supervise](typed.*.Behaviors$) {scala="#supervise[T](wrapped:org.apache.pekko.actor.typed.Behavior[T]):org.apache.pekko.actor.typed.scaladsl.Behaviors.Supervise[T]" java="#supervise(org.apache.pekko.actor.typed.Behavior)"} should be placed inside the @apidoc[setup](typed.*.Behaviors$) {scala="#setup[T](factory:org.apache.pekko.actor.typed.scaladsl.ActorContext[T]=%3Eorg.apache.pekko.actor.typed.Behavior[T]):org.apache.pekko.actor.typed.Behavior[T]" java="#setup(org.apache.pekko.japi.function.Function)"} and using when parent is restarted, the @apidoc[supervisee](typed.*.Behaviors$) {scala="#supervise[T](wrapped:org.apache.pekko.actor.typed.Behavior[T]):org.apache.pekko.actor.typed.scaladsl.Behaviors.Supervise[T]" java="#supervise(org.apache.pekko.actor.typed.Behavior)"} should be placed inside the @apidoc[setup](typed.*.Behaviors$) {scala="#setup[T](factory:org.apache.pekko.actor.typed.scaladsl.ActorContext[T]=%3Eorg.apache.pekko.actor.typed.Behavior[T]):org.apache.pekko.actor.typed.Behavior[T]" java="#setup(org.apache.pekko.japi.function.Function)"} and using
@scala[@scaladoc[SupervisorStrategy.restart.withStopChildren(false)](pekko.actor.typed.RestartSupervisorStrategy#withStopChildren(enabled:Boolean):org.apache.pekko.actor.typed.RestartSupervisorStrategy)]@java[@javadoc[SupervisorStrategy.restart().withStopChildren(false)](pekko.actor.typed.RestartSupervisorStrategy#withStopChildren(boolean))] @scala[@scaladoc[SupervisorStrategy.restart.withStopChildren(false)](pekko.actor.typed.RestartSupervisorStrategy#withStopChildren(enabled:Boolean):org.apache.pekko.actor.typed.RestartSupervisorStrategy)]@java[@javadoc[SupervisorStrategy.restart().withStopChildren(false)](pekko.actor.typed.RestartSupervisorStrategy#withStopChildren(boolean))]
like this: like this: