refactor: add description on fields

tintinthong · Aug 9, 2024 · 8dac2d4 · 8dac2d4
1 parent ae35fc3
commit 8dac2d4
Showing 1 changed file with 13 additions and 4 deletions.
diff --git a/packages/drafts-realm/campaign-members-chart.gts b/packages/drafts-realm/campaign-members-chart.gts
@@ -606,10 +606,19 @@ class Edit extends Component<typeof CampaignMembersChart> {
 export class CampaignMembersChart extends CardDef {
   static displayName = 'CampaignMembersChart';
 
-  @field name = contains(StringField);
-  @field chartType = contains(StringField);
-  @field contactMembers = containsMany(ContactMembersField);
-  @field leadMembers = containsMany(LeadMembersField);
+  @field name = contains(StringField, {
+    description: 'The campaign name',
+  });
+  @field chartType = contains(StringField, {
+    description:
+      'Chart type that will be displayed for showing sent and responded members',
+  });
+  @field contactMembers = containsMany(ContactMembersField, {
+    description: 'Contact members of the campaign, each with response status',
+  });
+  @field leadMembers = containsMany(LeadMembersField, {
+    description: 'Lead members of the campaign, each with response status',
+  });
 
   static isolated = Isolated;
   static embedded = Embedded;