From ad0ef8068463ef6dfbd536137ea832a0b1ae9628 Mon Sep 17 00:00:00 2001
From: lowercasedonkey <lowercasedonkey@gmail.com>
Date: Thu, 20 Feb 2020 11:34:44 -0500
Subject: [PATCH] better comment

---
 src/js/itemAvailability.js | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/src/js/itemAvailability.js b/src/js/itemAvailability.js
index 558133adbe3..b84cedd4432 100644
--- a/src/js/itemAvailability.js
+++ b/src/js/itemAvailability.js
@@ -211,7 +211,7 @@ window.isClothingAccessible = (function() {
 	 * @param {string} string Name of wearable item
 	 * @param {string} category that item is in clothing, collar, etc
 	 * @param {App.Entity.SlaveState} slave
-	 * @returns {boolean|string} Returns true if it is accessible, and if it is not either false or a string explaining why
+	 * @returns {boolean|string} Returns true if item is accessible, and false if it is not.  If the slave param is set, it may sometimes return a string instead of false, explaining why the item can't be used with that slave.
 	 */
 	function entry(string, category="clothing", slave) {
 		if (V.cheatMode === 1) {
-- 
GitLab