From 723197e44bdd17f986474a705e1d72b03360faf3 Mon Sep 17 00:00:00 2001
From: deuce <>
Date: Sun, 18 Aug 2019 04:42:51 +0000
Subject: [PATCH] Add note to user.get_time_left() documentation that you
likely want bbs.get_time_left() instead.
---
src/sbbs3/js_user.c | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)
diff --git a/src/sbbs3/js_user.c b/src/sbbs3/js_user.c
index 9b126c4c3d..b1225a434a 100644
--- a/src/sbbs3/js_user.c
+++ b/src/sbbs3/js_user.c
@@ -1269,7 +1269,8 @@ static jsSyncMethodSpec js_user_functions[] = {
{"get_time_left", js_get_time_left, 1, JSTYPE_NUMBER, JSDOCSTR("start_time")
,JSDOCSTR("Returns the user's available remaining time online, in seconds,<br>"
"based on the passed <i>start_time</i> value (in time_t format)<br>"
- "Note: this method does not account for pending forced timed events")
+ "Note: this method does not account for pending forced timed events"
+ "Note: for the pre-defined user object on the BBS, you almost certainly want bbs.get_time_left() instead.")
,31401
},
{0}
--
GitLab