Updated: Documentation!

Author: aloyak

interpreter/examples/libraries.sk

@@ -12,7 +12,7 @@ mylib.fibonacci(10)
 time.sleep(1)
 
 print("Pi: " + str(math.PI)) // PI from the math lib inside the simplelib library
-print("Now: " + str(time.formatTime(time.now())))
+print("Now: " + str(time.format(time.now())))
 
-let elapsed = time.stopTimer(timer)
+let elapsed = time.stopTimer(0)
 print("Test file took " + str(elapsed) + " seconds to run!")

interpreter/src/libs/time.rs

@@ -15,7 +15,7 @@ static TIMER_COUNTER: std::sync::atomic::AtomicU64 = std::sync::atomic::AtomicU6
 
 pub fn register(env: &mut Environment) {
     env.define("now".into(), Value::NativeFn(now));
-    env.define("formatTime".into(), Value::NativeFn(format_time));
+    env.define("format".into(), Value::NativeFn(format));
     env.define("sleep".into(), Value::NativeFn(sleep));
 
     env.define("startTimer".into(), Value::NativeFn(start_timer));
@@ -37,15 +37,15 @@ pub fn now(_args: Vec<Value>, span: TokenSpan, _: &mut Evaluator) -> Result<Valu
     }
 }
 
-pub fn format_time(args: Vec<Value>, span: TokenSpan, _: &mut Evaluator) -> Result<Value, Error> {
+pub fn format(args: Vec<Value>, span: TokenSpan, _: &mut Evaluator) -> Result<Value, Error> {
     use chrono::{DateTime, Utc};
     // YYYY-MM-DD: HH:MM:SS
     match args.first() {
         Some(Value::Number(n)) => {
             let dt = DateTime::<Utc>::from(UNIX_EPOCH + std::time::Duration::from_secs_f64(*n));
             Ok(Value::String(dt.format("%Y-%m-%d: %H:%M:%S").to_string()))
         }
-        _ => Err(err(span, "formatTime() expects 1 number".to_string())),
+        _ => Err(err(span, "format() expects 1 number".to_string())),
     }
 }
 

website/docs/Imports/libraries.md

@@ -5,12 +5,12 @@
 Currently SK includes these built-in libraries
 
 * The ```Math``` Library: See Imports/Math
+* The ```Time``` Library: See Imports/Time
 
 > More will be possibly added in the future
 
 ### TODO:
 
-* ```os```
-* ```files```
+* ```fs```
 * ```rand```
 * ```server*```

website/docs/Imports/time.md

@@ -0,0 +1,20 @@
+# Time
+
+## The ```time``` library
+
+```rs
+import time
+```
+
+Basic time library that includes some simple debugging functions too!
+
+* ```time.now()```, returns the current time in seconds from UNIX epoch
+* ```time.format()```, converts any timestamp from UNIX to ```YYYY-MM-DD: HH:MM:SS```
+* ```time.sleep```, freezes the thread for the given amount of seconds, if an interval is given, it will use the interval's midpoint
+
+### Timer
+
+The time library includes a timer! This creates a new thread that counts the time in seconds till the timer is stopped or the program is terminated.
+
+* ```time.startTimer()``` returns the timer ID, starting from 0
+* ```time.stopTimer(ID)``` returns the timer elapsed time since start in seconds, requieres the timer's id