Update catalyst_image.dart

input-output-hk · Nov 17, 2023 · 0a7efa8 · 0a7efa8
1 parent 0509df1
commit 0a7efa8
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/catalyst_voices/packages/catalyst_voices_assets/lib/src/catalyst_image.dart b/catalyst_voices/packages/catalyst_voices_assets/lib/src/catalyst_image.dart
@@ -1,5 +1,10 @@
 import 'package:flutter/widgets.dart';
 
+/// [CatalystImage] is a wrapper around [Image.asset] that sets the package
+/// property to `catalyst_voices_assets` by default.
+/// This allows the package to be used without having to specify
+/// the package name every time.
+/// For more information, see [Image.asset].
 final class CatalystImage {
   static Image asset(
     String name, {