doc comment

shorebirdtech · Aug 10, 2023 · d665c1e · d665c1e
1 parent 4b1a5c7
commit d665c1e
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/packages/shorebird_cli/lib/src/cache.dart b/packages/shorebird_cli/lib/src/cache.dart
@@ -11,9 +11,16 @@ import 'package:shorebird_cli/src/platform.dart';
 import 'package:shorebird_cli/src/process.dart';
 import 'package:shorebird_cli/src/shorebird_env.dart';
 
+/// {@template cache_update_failure}
+/// Thrown when a cache update fails.
+/// This can occur if the artifact is unreachable or
+/// if the download is interrupted.
+/// {@endtemplate}
 class CacheUpdateFailure implements Exception {
+  /// {@macro cache_update_failure}
   const CacheUpdateFailure(this.message);
 
+  /// The error message.
   final String message;
 
   @override