From 813ded4e578339996ba4cb38e83d35bcc8266196 Mon Sep 17 00:00:00 2001
From: Miguel Beltran <m@beltran.work>
Date: Mon, 1 Jul 2024 19:02:39 +0200
Subject: [PATCH] add Result class example

---
 compass_app/app/lib/common/utils/result.dart | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/compass_app/app/lib/common/utils/result.dart b/compass_app/app/lib/common/utils/result.dart
index dd2504ead..31715307f 100644
--- a/compass_app/app/lib/common/utils/result.dart
+++ b/compass_app/app/lib/common/utils/result.dart
@@ -1,4 +1,16 @@
 /// Utility class to wrap result data
+///
+/// Evaluate the result using a switch statement:
+/// ```dart
+/// switch (result) {
+///   case Ok(): {
+///     print(result.value);
+///   }
+///   case Error(): {
+///     print(result.error);
+///   }
+/// }
+/// ```
 sealed class Result<T> {
   const Result();