Release 1.0.2

- Small documentation and README improvements.

Author: vincevargadev

CHANGELOG.md

@@ -1,13 +1,17 @@
+## 1.0.2
+
+- Small documentation and README improvements.
+
 ## 1.0.1
 
 - Sync with the status of the stable branch on August 14, 2022. No significant changes from upstream, only documentation changes.
-- Improve the `compute` package's README and documentation
-- Clarify that this packages is synced with the `stable` branch
+- Improve the `compute` package's README and documentation.
+- Clarify that this packages is synced with the `stable` branch.
 
 ## 1.0.0
 
-- Stable release
+- Stable release.
 
 ## 0.1.0
 
-- Initial version
+- Initial version.

README.md

@@ -23,22 +23,21 @@ is a lot of boilerplate code when all you want to do is spawn an isolate, comput
 
 Flutter's `compute` function is a very useful abstraction over isolates that can be useful in all kinds of Dart apps.
 
-Unfortunately, Flutter's `compute` function is not available for a Dart package is it doesn't use Flutter.
-Examples where this can be the case are command-line and server-side applications.
+Unfortunately, Flutter's `compute` function is not available for a Dart package that doesn't use Flutter,
+for example command-line and server-side applications.
 
 This package addresses this issue. It extracts the `compute` function from Flutter and makes it available
-for all Dart projects, so if you wish to perform some computation on a separate isolate and use its return value
-in a command line tool, or any kind of non-Flutter Dart project, now you can!
+for all Dart projects, so if you wish to perform some computation on a separate isolate and use its return value, now you can!
 
 ## Disclaimers
 
 Do not assume that using `compute` will automatically speed up your code:
-you should benchmark your Dart applications *with* and *without* the `compute` function,
+you should benchmark your Dart applications *with and without the `compute` function*,
 and only switch to using `compute` if it really speeds up your application.
 
 Keep in mind, that by using `compute`, you lose some flexibility that working directly with isolates would enable you.
 
-The package is safe to be used on web, but there will be no real isolates spawned
+The package is safe to be used on web, but there will be no real isolates spawned.
 
 Changes are synced with Flutter's stable branch only (and they are currently synced manually).
 

lib/compute.dart

@@ -1,22 +1,32 @@
-/// When working with isolates, wiring up the `SendPort`s, the `ReceivePort`s correctly
-/// is a lot of boilerplate code when all you want to do is spawn an isolate, compute something, and use the computed value.
+/// When working with isolates, wiring up the `SendPort`s, the `ReceivePort`s
+/// correctly is a lot of boilerplate code when all you want to do is spawn an
+/// isolate, compute something, and use the computed value.
 ///
-/// Flutter's `compute` function is a very useful abstraction over isolates that can be useful in all kinds of Dart apps.
+/// Flutter's `compute` function is a very useful abstraction over isolates that
+/// can be useful in all kinds of Dart apps.
 ///
-/// Unfortunately, Flutter's `compute` function is not available for a Dart package is it doesn't use Flutter.
-/// Examples where this can be the case are command-line and server-side applications.
+/// Unfortunately, Flutter's `compute` function is not available for a Dart
+/// package that doesn't use Flutter, for example command-line and server-side
+/// applications.
 ///
-/// This package addresses this issue. It extracts the `compute` function from Flutter and makes it available
-/// for all Dart projects, so if you wish to perform some computation on a separate isolate and use its return value
-/// in a command line tool, or any kind of non-Flutter Dart project, now you can!
+/// This package addresses this issue. It extracts the `compute` function from
+/// Flutter and makes it available for all Dart projects, so if you wish to
+/// perform some computation on a separate isolate and use its return value,
+/// now you can!
+///
+/// **Disclaimers**
 ///
 /// Do not assume that using `compute` will automatically speed up your code:
-/// you should benchmark your Dart applications *with* and *without* the `compute` function,
-/// and only switch to using `compute` if it really speeds up your application.
+/// you should benchmark your Dart applications
+/// *with and without the `compute` function*, and only switch to using
+/// `compute` if it really speeds up your application.
 ///
-/// Keep in mind, that by using `compute`, you lose some flexibility that working directly with isolates would enable you.
+/// Keep in mind, that by using `compute`, you lose some flexibility that
+/// working directly with isolates would enable you.
 ///
-/// The package is safe to be used on web, but there will be no real isolates spawned
+/// The package is safe to be used on web, but there will be no real isolates
+/// spawned.
 ///
-/// Changes are synced with Flutter's stable branch only (and they are currently synced manually).
+/// Changes are synced with Flutter's stable branch only (and they are currently
+/// synced manually).
 export 'src/compute.dart';

lib/src/compute.dart

@@ -76,7 +76,6 @@ typedef ComputeImpl = Future<R> Function<Q, R>(
 ///
 /// {@youtube 560 315 https://www.youtube.com/watch?v=5AxWC49ZMzs}
 ///
-/// {@tool snippet}
 /// The following code uses the [compute] function to check whether a given
 /// integer is a prime number.
 ///
@@ -97,7 +96,6 @@ typedef ComputeImpl = Future<R> Function<Q, R>(
 ///   return true;
 /// }
 /// ```
-/// {@end-tool}
 ///
 /// The function used as `callback` must be one that can be sent to an isolate.
 /// {@template flutter.foundation.compute.callback}

pubspec.yaml

@@ -1,6 +1,6 @@
 name: compute
 description: Flutter's compute function made available for all non-Flutter Dart programs
-version: 1.0.1
+version: 1.0.2
 repository: https://github.com/dartsidedev/compute
 homepage: https://github.com/vincevargadev
 issue_tracker: https://github.com/dartsidedev/compute/issues