Docstrings, added info to input field"

fantasycalendar · Sep 1, 2021 · 3944a24 · 3944a24
1 parent 7b0a246
commit 3944a24
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -48,7 +48,7 @@ Gets all tags from a given object
 ```
 @param	{object}        inObject        The object get tags from
 
-@returns {array}                        The tags on the objects in an array
+@returns {array}                        An array of tags from the object
 ```
 
 ### Set Tags

diff --git a/scripts/module.js b/scripts/module.js
@@ -6,7 +6,7 @@ const Tagger = {
      * Gets all tags from a given object
      *
      * @param    {object}          inObject    The object get tags from
-     * @returns  {array}                       The tags on the objects in an array
+     * @returns  {array}                       An array of tags from the object
      */
     getTags(inObject) {
         if (inObject?.document) inObject = inObject.document;
@@ -206,7 +206,7 @@ const Tagger = {
         if (!obj) return;
         let tags = Tagger.getTags(obj)
         let html = `<fieldset style="margin: 3px 0;">
-			<legend>Tags</legend>
+			<legend>Tags (separated by commas)</legend>
 			<div class="form-group">
 				<input name="flags.${MODULE_NAME}.${FLAG_NAME}" type="text" value="${tags.join(', ')}">
 			</div>