From d665c1e73acc2581b5730d7a80c0dea0dcf81363 Mon Sep 17 00:00:00 2001
From: Felix Angelov <felix@shorebird.dev>
Date: Thu, 10 Aug 2023 16:14:51 -0500
Subject: [PATCH] doc comment

---
 packages/shorebird_cli/lib/src/cache.dart | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/packages/shorebird_cli/lib/src/cache.dart b/packages/shorebird_cli/lib/src/cache.dart
index 938e7d7c1..7075acb83 100644
--- 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