From 1feb26f89ef455f616aabe7197c7368400d14abd Mon Sep 17 00:00:00 2001 From: Ronan Takizawa <71115970+ronantakizawa@users.noreply.github.com> Date: Sat, 20 Sep 2025 02:04:55 -0600 Subject: [PATCH] fix: drop fiddle_code (#2237) * fix: drop fiddle_code * fix: fix indentation * fix: fix formatting * fix: fix failing pull request test --- .../scala/docs/org/apache/pekko/typed/IntroSpec.scala | 10 +--------- .../pekko/typed/fromclassic/ClassicSample.scala | 1 - docs/src/main/paradox/actors.md | 2 +- docs/src/main/paradox/stream/stream-quickstart.md | 2 +- docs/src/main/paradox/typed/actors.md | 2 +- docs/src/test/scala/docs/actor/ActorDocSpec.scala | 6 ------ .../docs/stream/TwitterStreamQuickstartDocSpec.scala | 11 +---------- 7 files changed, 5 insertions(+), 29 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 688ef2e1de..a5035bb91e 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 @@ -13,14 +13,12 @@ package docs.org.apache.pekko.typed -//#fiddle_code //#imports import org.apache.pekko import pekko.actor.typed.scaladsl.Behaviors import pekko.actor.typed.scaladsl.LoggerOps import pekko.actor.typed.{ ActorRef, ActorSystem, Behavior } //#imports -//#fiddle_code import pekko.NotUsed import pekko.Done @@ -35,17 +33,14 @@ import java.nio.charset.StandardCharsets object IntroSpec { //format: OFF - //#fiddle_code - + //#hello-world-actor object HelloWorld { final case class Greet(whom: String, replyTo: ActorRef[Greeted]) final case class Greeted(whom: String, from: ActorRef[Greet]) def apply(): Behavior[Greet] = Behaviors.receive { (context, message) => - //#fiddle_code context.log.info("Hello {}!", message.whom) - //#fiddle_code //#hello-world-actor println(s"Hello ${message.whom}!") //#hello-world-actor @@ -65,9 +60,7 @@ object IntroSpec { private def bot(greetingCounter: Int, max: Int): Behavior[HelloWorld.Greeted] = Behaviors.receive { (context, message) => val n = greetingCounter + 1 - //#fiddle_code context.log.info2("Greeting {} for {}", n, message.whom) - //#fiddle_code //#hello-world-bot println(s"Greeting $n for ${message.whom}") //#hello-world-bot @@ -111,7 +104,6 @@ object IntroSpec { // Entry point for the execution HelloWorldMain.main(Array.empty) - //#fiddle_code //format: ON object CustomDispatchersExample { diff --git a/actor-typed-tests/src/test/scala/docs/org/apache/pekko/typed/fromclassic/ClassicSample.scala b/actor-typed-tests/src/test/scala/docs/org/apache/pekko/typed/fromclassic/ClassicSample.scala index ba90b4be6a..1aaa4f820b 100644 --- a/actor-typed-tests/src/test/scala/docs/org/apache/pekko/typed/fromclassic/ClassicSample.scala +++ b/actor-typed-tests/src/test/scala/docs/org/apache/pekko/typed/fromclassic/ClassicSample.scala @@ -37,7 +37,6 @@ object ClassicSample { override def receive: Receive = { case Greet(whom) => - // #fiddle_code log.info("Hello {}!", whom) sender() ! Greeted(whom) } diff --git a/docs/src/main/paradox/actors.md b/docs/src/main/paradox/actors.md index 8b75934677..1f3ae5d347 100644 --- a/docs/src/main/paradox/actors.md +++ b/docs/src/main/paradox/actors.md @@ -97,7 +97,7 @@ construction. #### Here is another example: -@@snip [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) { #my-actor } @@@ diff --git a/docs/src/main/paradox/stream/stream-quickstart.md b/docs/src/main/paradox/stream/stream-quickstart.md index 206899b83a..1e6c1bae74 100644 --- a/docs/src/main/paradox/stream/stream-quickstart.md +++ b/docs/src/main/paradox/stream/stream-quickstart.md @@ -119,7 +119,7 @@ whether the stream terminated normally or exceptionally. Here is another example: -@@snip [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) { #first-sample } ## Reusable Pieces diff --git a/docs/src/main/paradox/typed/actors.md b/docs/src/main/paradox/typed/actors.md index 9fd95acfda..b0a0fa22bf 100644 --- a/docs/src/main/paradox/typed/actors.md +++ b/docs/src/main/paradox/typed/actors.md @@ -167,7 +167,7 @@ You will also need to add a @ref:[logging dependency](logging.md) to see that ou #### Here is another example: -@@snip [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) { #hello-world-main } @@@ diff --git a/docs/src/test/scala/docs/actor/ActorDocSpec.scala b/docs/src/test/scala/docs/actor/ActorDocSpec.scala index 42206a70ca..0e0c30865f 100644 --- a/docs/src/test/scala/docs/actor/ActorDocSpec.scala +++ b/docs/src/test/scala/docs/actor/ActorDocSpec.scala @@ -332,7 +332,6 @@ final case class Give(thing: Any) //#receive-orElse -//#fiddle_code import org.apache.pekko.actor.{ Actor, ActorRef, ActorSystem, PoisonPill, Props } import scala.concurrent.duration._ @@ -364,8 +363,6 @@ class Ponger(pinger: ActorRef) extends Actor { } } -//#fiddle_code - //#immutable-message-definition case class User(name: String) @@ -409,7 +406,6 @@ class ActorDocSpec extends PekkoSpec(""" } "run basic Ping Pong" in { - // #fiddle_code val system = ActorSystem("pingpong") val pinger = system.actorOf(Props[Pinger](), "pinger") @@ -421,8 +417,6 @@ class ActorDocSpec extends PekkoSpec(""" ponger ! Ping } - // #fiddle_code - val testProbe = new TestProbe(system) testProbe.watch(pinger) testProbe.expectTerminated(pinger) diff --git a/docs/src/test/scala/docs/stream/TwitterStreamQuickstartDocSpec.scala b/docs/src/test/scala/docs/stream/TwitterStreamQuickstartDocSpec.scala index b11217ad27..5fdad9c850 100644 --- a/docs/src/test/scala/docs/stream/TwitterStreamQuickstartDocSpec.scala +++ b/docs/src/test/scala/docs/stream/TwitterStreamQuickstartDocSpec.scala @@ -29,7 +29,6 @@ import org.apache.pekko.testkit.PekkoSpec import scala.concurrent.ExecutionContext object TwitterStreamQuickstartDocSpec { - // #fiddle_code import org.apache.pekko import pekko.NotUsed import pekko.actor.ActorSystem @@ -53,15 +52,12 @@ object TwitterStreamQuickstartDocSpec { val pekkoTag = Hashtag("#pekko") // #model - // #fiddle_code - abstract class TweetSourceDecl { // #tweet-source val tweets: Source[Tweet, NotUsed] // #tweet-source } - // #fiddle_code val tweets: Source[Tweet, NotUsed] = Source( Tweet(Author("rolandkuhn"), System.currentTimeMillis, "#pekko rocks!") :: Tweet(Author("patriknw"), System.currentTimeMillis, "#pekko !") :: @@ -75,7 +71,6 @@ object TwitterStreamQuickstartDocSpec { Tweet(Author("drama"), System.currentTimeMillis, "we compared #apples to #oranges!") :: Nil) - // #fiddle_code } class TwitterStreamQuickstartDocSpec extends PekkoSpec { @@ -87,14 +82,12 @@ class TwitterStreamQuickstartDocSpec extends PekkoSpec { def println(s: Any): Unit = () trait Example1 { - // #fiddle_code // #first-sample // #system-setup implicit val system: ActorSystem = ActorSystem("reactive-tweets") // #system-setup // #first-sample - // #fiddle_code } "filter and map" in { @@ -158,9 +151,8 @@ class TwitterStreamQuickstartDocSpec extends PekkoSpec { // format: ON } - "simple fiddle showcase" in { + "simple example showcase" in { - // #fiddle_code tweets .filterNot(_.hashtags.contains(pekkoTag)) // Remove all tweets containing #pekko hashtag .map(_.hashtags) // Get all sets of hashtags ... @@ -168,7 +160,6 @@ class TwitterStreamQuickstartDocSpec extends PekkoSpec { .mapConcat(identity) // Flatten the set of hashtags to a stream of hashtags .map(_.name.toUpperCase) // Convert all hashtags to upper case .runWith(Sink.foreach(println)) // Attach the Flow to a Sink that will finally print the hashtags - // #fiddle_code .value }