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 { const Result();