You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pekko.apache.org by he...@apache.org on 2026/10/09 05:25:47 UTC
(pekko) 01/01: docs: fix the broken Array[Byte] scaladoc link in io.md
This is an automated email from the ASF dual-hosted git repository.
He-Pin pushed a commit to branch docs-fix-io-array-scaladoc
in repository https://gitbox.apache.org/repos/asf/pekko.git
commit d839005a1d908d145e6709b6d0cdd5fcfb880d77
Author: 虎鸣 <he...@alibaba-inc.com>
AuthorDate: Fri Oct 9 13:25:26 2026 +0800
docs: fix the broken Array[Byte] scaladoc link in io.md
Motivation:
The ByteString paragraph used a malformed nested scaladoc directive
(`@scaladoc[Array](scala.Array)[@scaladoc[Byte](scala.Byte)]`) that does
not match the paradox directive grammar, so the Scala tab did not render
a proper link.
Modification:
Replace it with the established single-directive form used elsewhere in
the docs, e.g. `@scaladoc[Try[T]](scala.util.Try)`.
Result:
The Scala tab renders `Array[Byte]` as one working scaladoc link.
Tests:
- Not run - docs only
References:
None - follow-up found while reviewing #3587/#3588
---
docs/src/main/paradox/io.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/docs/src/main/paradox/io.md b/docs/src/main/paradox/io.md
index dfd48cf633..ff15038400 100644
--- a/docs/src/main/paradox/io.md
+++ b/docs/src/main/paradox/io.md
@@ -92,7 +92,7 @@ not error handling. In other words, data may still be lost, even if every write
To maintain isolation, actors should communicate with immutable objects only. @apidoc[ByteString](util.ByteString) is an
immutable container for bytes. It is used by Pekko's I/O system as an efficient, immutable alternative
-to the traditional byte containers used for I/O on the JVM, such as @scala[@scaladoc[Array](scala.Array)[@scaladoc[Byte](scala.Byte)]]@java[`byte[]`] and @javadoc[ByteBuffer](java.nio.ByteBuffer).
+to the traditional byte containers used for I/O on the JVM, such as @scala[@scaladoc[Array[Byte]](scala.Array)]@java[`byte[]`] and @javadoc[ByteBuffer](java.nio.ByteBuffer).
`ByteString` is a [rope-like](https://en.wikipedia.org/wiki/Rope_\(computer_science\)) data structure that is immutable
and provides fast concatenation and slicing operations (perfect for I/O). When two `ByteString`s are concatenated
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@pekko.apache.org
For additional commands, e-mail: commits-help@pekko.apache.org