This is an automated email from the ASF dual-hosted git repository.
fanningpj pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-pekko.git
The following commit(s) were added to refs/heads/main by this push:
new 53e54104ef Fixing #246: update signature and fiddle properties in
project/Paradox.scala (#302)
53e54104ef is described below
commit 53e54104efc856a208e8f51fdd8dc01bd5b61cf1
Author: Samuele Resca <[email protected]>
AuthorDate: Thu Apr 27 20:20:29 2023 +0100
Fixing #246: update signature and fiddle properties in
project/Paradox.scala (#302)
* Updating Paradox props.
* Reverting scalafiddle props.
* Removing @@signature placeholder in favour of apidocs.
* Coverting scalafiddler examples to standard examples.
---------
Co-authored-by: Samuele Resca <[email protected]>
---
.../src/test/scala/docs/org/apache/pekko/typed/IntroSpec.scala | 2 +-
docs/src/main/paradox/_template/projectSpecificFooter.st | 1 -
docs/src/main/paradox/actors.md | 4 ++--
docs/src/main/paradox/assets/js/scalafiddle.js | 8 --------
.../src/main/paradox/stream/operators/Source/mergePrioritizedN.md | 2 +-
docs/src/main/paradox/stream/stream-quickstart.md | 6 +++---
docs/src/main/paradox/typed/actors.md | 4 ++--
project/Paradox.scala | 3 ---
8 files changed, 9 insertions(+), 21 deletions(-)
diff --git
a/actor-typed-tests/src/test/scala/docs/org/apache/pekko/typed/IntroSpec.scala
b/actor-typed-tests/src/test/scala/docs/org/apache/pekko/typed/IntroSpec.scala
index 441e70acbf..a4e0a4baa7 100644
---
a/actor-typed-tests/src/test/scala/docs/org/apache/pekko/typed/IntroSpec.scala
+++
b/actor-typed-tests/src/test/scala/docs/org/apache/pekko/typed/IntroSpec.scala
@@ -109,7 +109,7 @@ object IntroSpec {
}
//#hello-world-main
- // This is run by ScalaFiddle
+ // Entry point for the execution
HelloWorldMain.main(Array.empty)
//#fiddle_code
//format: ON
diff --git a/docs/src/main/paradox/_template/projectSpecificFooter.st
b/docs/src/main/paradox/_template/projectSpecificFooter.st
index 4b90de6192..a10db6f4e7 100644
--- a/docs/src/main/paradox/_template/projectSpecificFooter.st
+++ b/docs/src/main/paradox/_template/projectSpecificFooter.st
@@ -1,2 +1 @@
<script type="text/javascript"
src="$page.base$assets/js/warnOldDocs.js"></script>
-<script type="text/javascript"
src="$page.base$assets/js/scalafiddle.js"></script>
diff --git a/docs/src/main/paradox/actors.md b/docs/src/main/paradox/actors.md
index 54232ac236..60057b95f3 100644
--- a/docs/src/main/paradox/actors.md
+++ b/docs/src/main/paradox/actors.md
@@ -95,9 +95,9 @@ construction.
@@@ div { .group-scala }
-#### Here is another example that you can edit and run in the browser:
+#### Here is another example:
-@@fiddle
[ActorDocSpec.scala](/docs/src/test/scala/docs/actor/ActorDocSpec.scala) {
#fiddle_code template="Pekko" layout="v75" minheight="400px" }
+@@snip
[ActorDocSpec.scala](/docs/src/test/scala/docs/actor/ActorDocSpec.scala) {
#fiddle_code template="Pekko" layout="v75" minheight="400px" }
@@@
diff --git a/docs/src/main/paradox/assets/js/scalafiddle.js
b/docs/src/main/paradox/assets/js/scalafiddle.js
deleted file mode 100644
index 90e75d7b73..0000000000
--- a/docs/src/main/paradox/assets/js/scalafiddle.js
+++ /dev/null
@@ -1,8 +0,0 @@
-window.scalaFiddleTemplates = {
- "Pekko": {
- pre: "// $FiddleDependency org.pekko-js %%% pekkojsactor % 2.2.6.1 \n" +
- "// $FiddleDependency org.pekko-js %%% pekkojsactorstream % 2.2.6.1 \n" +
- "// $FiddleDependency org.pekko-js %%% pekkojsactortyped % 2.2.6.1 \n",
- post: ""
- }
-}
diff --git a/docs/src/main/paradox/stream/operators/Source/mergePrioritizedN.md
b/docs/src/main/paradox/stream/operators/Source/mergePrioritizedN.md
index 1f655816bd..9a2fb08a30 100644
--- a/docs/src/main/paradox/stream/operators/Source/mergePrioritizedN.md
+++ b/docs/src/main/paradox/stream/operators/Source/mergePrioritizedN.md
@@ -6,7 +6,7 @@ Merge multiple sources with priorities.
## Signature
-@@signature
[Source.scala](/pekko-stream/src/main/scala/org/apache/pekko/stream/scaladsl/Source.scala)
{ #mergePrioritized }
+@apidoc[Source.mergePrioritizedN](Source) {
scala="#mergePrioritizedN[T](sourcesAndPriorities:immutable.Seq[(Source[T,_],Int)],eagerComplete:Boolean):Source[T,NotUsed]"
java="#mergePrioritized[T](sourcesAndPriorities:java.util.List[Pair[Source[T,_%3C:Any],java.lang.Integer]],eagerComplete:Boolean):javadsl.Source[T,NotUsed]"
}
## Description
diff --git a/docs/src/main/paradox/stream/stream-quickstart.md
b/docs/src/main/paradox/stream/stream-quickstart.md
index 999b23ed86..206899b83a 100644
--- a/docs/src/main/paradox/stream/stream-quickstart.md
+++ b/docs/src/main/paradox/stream/stream-quickstart.md
@@ -116,10 +116,10 @@ whether the stream terminated normally or exceptionally.
### Browser-embedded example
-<a
name="here-is-another-example-that-you-can-edit-and-run-in-the-browser-"></a>
-Here is another example that you can edit and run in the browser:
+<a name="here-is-another-example"></a>
+Here is another example:
-@@fiddle
[TwitterStreamQuickstartDocSpec.scala](/docs/src/test/scala/docs/stream/TwitterStreamQuickstartDocSpec.scala)
{ #fiddle_code template=Pekko layout=v75 minheight=400px }
+@@snip
[TwitterStreamQuickstartDocSpec.scala](/docs/src/test/scala/docs/stream/TwitterStreamQuickstartDocSpec.scala)
{ #fiddle_code template=Pekko layout=v75 minheight=400px }
## Reusable Pieces
diff --git a/docs/src/main/paradox/typed/actors.md
b/docs/src/main/paradox/typed/actors.md
index a2d2ce522a..9fd95acfda 100644
--- a/docs/src/main/paradox/typed/actors.md
+++ b/docs/src/main/paradox/typed/actors.md
@@ -165,9 +165,9 @@ You will also need to add a @ref:[logging
dependency](logging.md) to see that ou
@@@ div { .group-scala }
-#### Here is another example that you can edit and run in the browser:
+#### Here is another example:
-@@fiddle
[IntroSpec.scala](/actor-typed-tests/src/test/scala/docs/org/apache/pekko/typed/IntroSpec.scala)
{ #fiddle_code template=Pekko layout=v75 minheight=400px }
+@@snip
[IntroSpec.scala](/actor-typed-tests/src/test/scala/docs/org/apache/pekko/typed/IntroSpec.scala)
{ #fiddle_code template=Pekko layout=v75 minheight=400px }
@@@
diff --git a/project/Paradox.scala b/project/Paradox.scala
index 2fcbdf1d31..7beccaa21d 100644
--- a/project/Paradox.scala
+++ b/project/Paradox.scala
@@ -61,9 +61,6 @@ object Paradox {
"pekko.version" -> version.value,
"scalatest.version" -> Dependencies.scalaTestVersion.value,
"sigar_loader.version" -> "1.6.6-rev002",
- "signature.akka.base_dir" -> (ThisBuild /
baseDirectory).value.getAbsolutePath,
- "fiddle.code.base_dir" -> (Test / sourceDirectory).value.getAbsolutePath,
- "fiddle.akka.base_dir" -> (ThisBuild /
baseDirectory).value.getAbsolutePath,
"aeron_version" -> Dependencies.aeronVersion,
"netty_version" -> Dependencies.nettyVersion,
"logback_version" -> Dependencies.logbackVersion))
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
