📝 Clarify item template attributes

ebullient · Apr 19, 2024 · cdf1d03 · cdf1d03
1 parent 2817b4c
commit cdf1d03
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 6 deletions.
diff --git a/docs/templates/dnd5e/QuteItem/README.md b/docs/templates/dnd5e/QuteItem/README.md
@@ -31,7 +31,7 @@ Two-handed Damage string, if applicable. Contains dice formula and damage type
 
 ### detail
 
-Item details: tier, rarity, category, attunement
+Formatted string of item details. Will include some combination of tier, rarity, category, and attunement
 
 ### fluffImages
 
@@ -55,7 +55,7 @@ Formatted text listing other prerequisite conditions (optional)
 
 ### properties
 
-List of item's properties (with links to rules if the source is present)
+Formatted string listing item's properties (with links to rules if the source is present)
 
 ### range
 

diff --git a/docs/templates/dnd5e/QuteItem/Variant.md b/docs/templates/dnd5e/QuteItem/Variant.md
@@ -36,7 +36,7 @@ Formatted text listing other prerequisite conditions (optional)
 
 ### properties
 
-List of item's properties (with links to rules if the source is present)
+Formatted string listing item's properties (with links to rules if the source is present)
 
 ### range
 

diff --git a/src/main/java/dev/ebullient/convert/tools/dnd5e/qute/QuteItem.java b/src/main/java/dev/ebullient/convert/tools/dnd5e/qute/QuteItem.java
@@ -19,7 +19,7 @@
 @TemplateData
 public class QuteItem extends Tools5eQuteBase {
 
-    /** Item details: tier, rarity, category, attunement */
+    /** Formatted string of item details. Will include some combination of tier, rarity, category, and attunement */
     public final String detail;
     /** Changes to armor class provided by the item, if applicable */
     public final String armorClass;
@@ -29,7 +29,7 @@ public class QuteItem extends Tools5eQuteBase {
     public final String damage2h;
     /** Item's range, if applicable */
     public final String range;
-    /** List of item's properties (with links to rules if the source is present) */
+    /** Formatted string listing item's properties (with links to rules if the source is present) */
     public final String properties;
     /** Strength requirement as a numerical value, if applicable */
     public final Integer strengthRequirement;
@@ -110,7 +110,7 @@ public static class Variant {
         public final String damage2h;
         /** Item's range, if applicable */
         public final String range;
-        /** List of item's properties (with links to rules if the source is present) */
+        /** Formatted string listing item's properties (with links to rules if the source is present) */
         public final String properties;
         /** Strength requirement as a numerical value, if applicable */
         public final Integer strengthRequirement;