refresh snippets

dart-lang · Jan 4, 2024 · 508c6ae · 508c6ae
1 parent a43eca4
commit 508c6ae
Show file tree

Hide file tree

Showing 8 changed files with 29 additions and 29 deletions.
diff --git a/examples/concurrency/lib/robust_ports_example/complete.dart b/examples/concurrency/lib/robust_ports_example/complete.dart
@@ -42,7 +42,7 @@ class Worker {
       ));
     };
 
-    // Spawn the isolate
+    // Spawn the isolate.
     try {
       await Isolate.spawn(_startRemoteIsolate, (initPort.sendPort));
     } on Object {

diff --git a/examples/concurrency/lib/robust_ports_example/spawn_1.dart b/examples/concurrency/lib/robust_ports_example/spawn_1.dart
@@ -9,7 +9,7 @@ class Worker {
   final ReceivePort _responses;
 
   static Future<Worker> spawn() async {
-    // Create a receive port and add it's initial message handler
+    // Create a receive port and add its initial message handler.
     final initPort = RawReceivePort();
     final connection = Completer<(ReceivePort, SendPort)>.sync();
     initPort.handler = (initialMessage) {
@@ -26,12 +26,12 @@ class Worker {
 // #enddocregion
 
   Future<Object?> parseJson(String message) async {
-    // TODO: ensure the port is still open
+    // TODO: Ensure the port is still open.
     _commands.send(message);
   }
 
   Worker._(this._commands, this._responses) {
-    // TODO: initialize main isolate receive port listener
+    // TODO: Initialize main isolate receive port listener.
   }
 
   void _handleResponsesFromIsolate(dynamic message) {
@@ -43,6 +43,6 @@ class Worker {
   }
 
   static void _startRemoteIsolate(SendPort sp) {
-    // TODO: Initialize worker isolate's ports
+    // TODO: Initialize worker isolate's ports.
   }
 }
diff --git a/examples/concurrency/lib/robust_ports_example/spawn_2.dart b/examples/concurrency/lib/robust_ports_example/spawn_2.dart
@@ -9,7 +9,7 @@ class Worker {
   final ReceivePort _responses;
 
   static Future<Worker> spawn() async {
-    // Create a receive port and add it's initial message handler
+    // Create a receive port and add its initial message handler
     final initPort = RawReceivePort();
     final connection = Completer<(ReceivePort, SendPort)>.sync();
     initPort.handler = (initialMessage) {
@@ -19,7 +19,7 @@ class Worker {
         commandPort,
       ));
     };
-    // Spawn the isolate
+    // Spawn the isolate.
     try {
       await Isolate.spawn(_startRemoteIsolate, (initPort.sendPort));
     } on Object {
@@ -35,12 +35,12 @@ class Worker {
 // #enddocregion
 
   Future<Object?> parseJson(String message) async {
-    // TODO: ensure the port is still open
+    // TODO: Ensure the port is still open.
     _commands.send(message);
   }
 
   Worker._(this._commands, this._responses) {
-    // TODO: initialize main isolate receive port listener
+    // TODO: Initialize main isolate receive port listener.
   }
 
   void _handleResponsesFromIsolate(dynamic message) {
@@ -52,6 +52,6 @@ class Worker {
   }
 
   static void _startRemoteIsolate(SendPort sp) {
-    // TODO: Initialize worker isolate's ports
+    // TODO: Initialize worker isolate's ports.
   }
 }
diff --git a/examples/concurrency/lib/robust_ports_example/start.dart b/examples/concurrency/lib/robust_ports_example/start.dart
@@ -8,18 +8,18 @@ class Worker {
   final ReceivePort _responses;
 
   Future<Object?> parseJson(String message) async {
-    // TODO: ensure the port is still open
+    // TODO: Ensure the port is still open.
     _commands.send(message);
   }
 
   static Future<Worker> spawn() async {
     // TODO: Add functionality to create a new Worker object with a
-    //  connection to a spawned isolate
+    //  connection to a spawned isolate.
     throw UnimplementedError();
   }
 
   Worker._(this._commands, this._responses) {
-    // TODO: initialize main isolate receive port listener
+    // TODO: Initialize main isolate receive port listener.
   }
 
   void _handleResponsesFromIsolate(dynamic message) {
@@ -31,7 +31,7 @@ class Worker {
   }
 
   static void _startRemoteIsolate(SendPort sp) {
-    // TODO: Initialize worker isolate's ports
+    // TODO: Initialize worker isolate's ports.
   }
 }
 // #enddocregion
diff --git a/examples/concurrency/lib/robust_ports_example/step_4.dart b/examples/concurrency/lib/robust_ports_example/step_4.dart
@@ -20,7 +20,7 @@ class Worker {
         commandPort,
       ));
     };
-    // Spawn the isolate
+    // Spawn the isolate.
     try {
       await Isolate.spawn(_startRemoteIsolate, (initPort.sendPort));
     } on Object {

diff --git a/examples/concurrency/lib/robust_ports_example/step_5_add_completers.dart b/examples/concurrency/lib/robust_ports_example/step_5_add_completers.dart
@@ -23,7 +23,7 @@ class Worker {
         commandPort,
       ));
     };
-    // Spawn the isolate
+    // Spawn the isolate.
     try {
       await Isolate.spawn(_startRemoteIsolate, (initPort.sendPort));
     } on Object {

diff --git a/examples/concurrency/lib/robust_ports_example/step_6_close_ports.dart b/examples/concurrency/lib/robust_ports_example/step_6_close_ports.dart
@@ -24,7 +24,7 @@ class Worker {
         commandPort,
       ));
     };
-    // Spawn the isolate
+    // Spawn the isolate.
     try {
       await Isolate.spawn(_startRemoteIsolate, (initPort.sendPort));
     } on Object {
@@ -70,7 +70,7 @@ class Worker {
     SendPort sendPort,
   ) {
     receivePort.listen((message) {
-      // New if-block
+      // New if-block.
       if (message == 'shutdown') {
         receivePort.close();
         return;

diff --git a/src/language/isolates.md b/src/language/isolates.md
@@ -438,7 +438,7 @@ To handle this, use a [`Completer`][].
 - First, add a class-level property called a `Completer` and name
   it `_isolateReady`.
 - Next, add a call to `complete()` on the completer in
-  the `_handleResponsesFromIsolate` method (created in step 4) if the message is
+  the `_handleResponsesFromIsolate` method (created in [step 4](#step-4-handle-messages-on-the-main-isolate)) if the message is
   a `SendPort`.
 - Finally, in the `parseJson` method, add `await _isolateReady.future` before
   adding `_sendPort.send`. This ensures that no message can be sent to the
@@ -549,18 +549,18 @@ class Worker {
   final ReceivePort _responses;
 
   Future<Object?> parseJson(String message) async {
-    // TODO: ensure the port is still open
+    // TODO: Ensure the port is still open.
     _commands.send(message);
   }
 
   static Future<Worker> spawn() async {
     // TODO: Add functionality to create a new Worker object with a
-    //  connection to a spawned isolate
+    //  connection to a spawned isolate.
     throw UnimplementedError();
   }
 
   Worker._(this._commands, this._responses) {
-    // TODO: initialize main isolate receive port listener
+    // TODO: Initialize main isolate receive port listener.
   }
 
   void _handleResponsesFromIsolate(dynamic message) {
@@ -572,7 +572,7 @@ class Worker {
   }
 
   static void _startRemoteIsolate(SendPort sp) {
-    // TODO: Initialize worker isolate's ports
+    // TODO: Initialize worker isolate's ports.
   }
 }
 ```
@@ -618,7 +618,7 @@ class Worker {
   final ReceivePort _responses;
 
   static Future<Worker> spawn() async {
-    // Create a receive port and add it's initial message handler
+    // Create a receive port and add its initial message handler.
     final initPort = RawReceivePort();
     final connection = Completer<(ReceivePort, SendPort)>.sync();
     initPort.handler = (initialMessage) {
@@ -643,7 +643,7 @@ logic that handles receiving messages after setting up communication is
 complete. This benefit will become more obvious as the logic in the other
 methods grows.
 
-#### Step 3: Spawn a worker isolate with `Isolate.spawn`.
+#### Step 3: Spawn a worker isolate with `Isolate.spawn`
 
 This step continues to fill in the `Worker.spawn` method. You’ll add the code
 needed to spawn an isolate, and return an instance of `Worker` from this class.
@@ -667,7 +667,7 @@ class Worker {
   final ReceivePort _responses;
 
   static Future<Worker> spawn() async {
-    // Create a receive port and add it's initial message handler
+    // Create a receive port and add its initial message handler
     final initPort = RawReceivePort();
     final connection = Completer<(ReceivePort, SendPort)>.sync();
     initPort.handler = (initialMessage) {
@@ -677,7 +677,7 @@ class Worker {
         commandPort,
       ));
     };
-    // Spawn the isolate
+    // Spawn the isolate.
     try {
       await Isolate.spawn(_startRemoteIsolate, (initPort.sendPort));
     } on Object {
@@ -943,7 +943,7 @@ static void _handleCommandsToIsolate(
   SendPort sendPort,
 ) {
   receivePort.listen((message) {
-    // New if-block
+    // New if-block.
     if (message == 'shutdown') {
       receivePort.close();
       return;
@@ -1023,7 +1023,7 @@ class Worker {
       ));
     };
 
-    // Spawn the isolate
+    // Spawn the isolate.
     try {
       await Isolate.spawn(_startRemoteIsolate, (initPort.sendPort));
     } on Object {