From 3a0521cb731779f32cd6939b56da1381de481c53 Mon Sep 17 00:00:00 2001
From: DCoded <dcoded@live.com>
Date: Mon, 11 Mar 2019 01:01:45 -0400
Subject: [PATCH] Updated documentation

---
 devNotes/Useful JS Function Documentation.txt | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/devNotes/Useful JS Function Documentation.txt b/devNotes/Useful JS Function Documentation.txt
index 1c43d2d4bae..ddba478313f 100644
--- a/devNotes/Useful JS Function Documentation.txt	
+++ b/devNotes/Useful JS Function Documentation.txt	
@@ -167,10 +167,10 @@ lispReplace(string) - Returns the string lispified.
 nippleColor(slave) - Returns the slave's nipple color.
 
 UtilJS [script]
-	TODO: update this
-	num() - Returns the value thousand separated with ',' if $formatNumbers > 0 else provides the raw value.
+	num() - Returns the value thousand separated with ',' if $formatNumbers > 0 else provides the raw value. Returns an integer if $showNumbers == 0, numbers up to a preset max as words if $showNumbers == 1, or only words if $showNumbers == 2.
 		line 138 of src/SpecialForce/Report.tw, '...focused their <<print num($SFUnit.Troops)>> troops'
 		if $formatNumbers > 0 'focused their 1,589 troops' else 'focused their 1589 troops'
+		if $showNumbers == 0 'focused their 1,589 troops', if $showNumbers == 1 'focused their 1,589 troops' (unless the max is set to more than 1,589), else 'focused their one thousand five hundred eighty-nine troops'
 
 	cashFormat() - uses the above function to return the value thousand separated with ',' if $formatNumbers > 0 else provides the raw value. either way prepends ¤ (the fc domination) symbol.
 		line 157 of the previously listed file, '...totaling @@.yellowgreen;<<print cashFormat(_SFIncome)>>@@'
-- 
GitLab