From 57050b5745b86faba6a5f419e3d62ddd7aa72a2e Mon Sep 17 00:00:00 2001
From: Rob Swindell <rob@synchro.net>
Date: Thu, 3 Feb 2022 19:22:27 -0800
Subject: [PATCH] JSDOC note to clarify that Archive() cannot be used to update
 an archive

---
 src/sbbs3/js_archive.c | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/src/sbbs3/js_archive.c b/src/sbbs3/js_archive.c
index 34e754f8e6..a82c26da1d 100644
--- a/src/sbbs3/js_archive.c
+++ b/src/sbbs3/js_archive.c
@@ -614,7 +614,8 @@ js_archive_constructor(JSContext *cx, uintN argc, jsval *arglist)
 	}
 
 #ifdef BUILD_JSDOCS
-	js_DescribeSyncObject(cx,obj,"Class used for opening, creating, reading, or writing archive files on the local file system"
+	js_DescribeSyncObject(cx,obj,"Class used for creating, reading, or extracting archive files on the local file system<br>"
+		"Note: cannot be used to update (e.g. add/remove/replace files in) an existing archive."
 		,31900
 		);
 	js_DescribeSyncConstructor(cx,obj,"To create a new Archive object: <tt>var a = new Archive(<i>filename</i>)</tt>");
-- 
GitLab