You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@pekko.apache.org by "pjfanning (via GitHub)" <gi...@apache.org> on 2026/10/08 14:04:24 UTC
[PR] [1.7.x] docs: fix markup that breaks page rendering [pekko]
pjfanning opened a new pull request, #3580:
URL: https://github.com/apache/pekko/pull/3580
### 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 (they had been mangled to `(/actor-typed` etc.)
- `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 (they were swapped, so each tab showed the other language's links)
- `persistence.md`: fix the escaped `\@scala[` in the persist/persistAll sentence, which printed literally, 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 instead of showing literal backticks
### Result
The affected pages render as intended.
### Tests
- Not run locally - docs only; identical change to #3579, where `sbt docs/paradox` passed and the generated HTML was checked
### References
Refs #3579 (backport to 1.7.x)
--
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: notifications-unsubscribe@pekko.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org
Re: [PR] [1.7.x] docs: fix markup that breaks page rendering [pekko]
Posted by "He-Pin (via GitHub)" <gi...@apache.org>.
He-Pin commented on PR #3580:
URL: https://github.com/apache/pekko/pull/3580#issuecomment-6074858987
Pushed b122856 to align the Java sample with the Scala tab (`getLastEnqueued()` -> `getLastEnqueuedMessage()`), matching what #3579 does on main, so the two branches stay consistent. Will merge once CI is green.
--
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: notifications-unsubscribe@pekko.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org
Re: [PR] [1.7.x] docs: fix markup that breaks page rendering [pekko]
Posted by "He-Pin (via GitHub)" <gi...@apache.org>.
He-Pin merged PR #3580:
URL: https://github.com/apache/pekko/pull/3580
--
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: notifications-unsubscribe@pekko.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org
Re: [PR] [1.7.x] docs: fix markup that breaks page rendering [pekko]
Posted by "He-Pin (via GitHub)" <gi...@apache.org>.
He-Pin commented on code in PR #3580:
URL: https://github.com/apache/pekko/pull/3580#discussion_r4226604520
##########
docs/src/main/paradox/mailboxes.md:
##########
@@ -208,7 +208,7 @@ Java
```java
final Props props = ...
// this actor uses MyCustomMailbox, which is assumed to be a singleton
- system.actorOf(props.withDispatcher("myCustomMailbox").tell("bang", sender);
+ system.actorOf(props.withMailbox("myCustomMailbox")).tell("bang", sender);
assert(MyCustomMailbox.getInstance().getLastEnqueued().equals("bang"));
Review Comment:
This line still reads `getLastEnqueued()` while the Scala tab two lines above uses `getLastEnqueuedMessage`, and both tabs describe the same `MyCustomMailbox` singleton - so the Java accessor is wrong. #3579 aligns it on main; could you bring the same fix here so the two branches do not diverge?
--
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: notifications-unsubscribe@pekko.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@pekko.apache.org
For additional commands, e-mail: notifications-help@pekko.apache.org