funscheduler

commit d7c68af31741e003fae919d0c5a1173d608526f0
parent 26aa346ebb11cf2d31030484deede3ed17e84893
Author: Jackson G. Kaindume <seestem@protonmail.com>
Date:   Thu, 15 Jul 2021 23:05:22 +0200

docs and comments

Diffstat:
M
README
 | 
9
++++-----
M
src/lib.rs
 | 
7
++-----

2 files changed, 6 insertions(+), 10 deletions(-)
diff --git a/README b/README
@@ -21,10 +21,10 @@
   Timings: Easily congigure the timing of the function execution
 ----------------------------------------------------------------------
 
-    - Timing::Seconds(1)    // Every second
-    - Timing::Minutes(25)   // Every 25 minutes
-    - Timing::Hours(2)      // Every 2 hours
-    - Timing::Days(1)       // Every day same as Timing::Hours(24)
+      Timing::Seconds(1)    // Every second
+      Timing::Minutes(25)   // Every 25 minutes
+      Timing::Hours(2)      // Every 2 hours
+      Timing::Days(1)       // Every day same as Timing::Hours(24)
     
 ----------------------------------------------------------------------
   Job runners: Different ways to execute the function
@@ -40,7 +40,6 @@
     // Execute function once after a specified amount of time
     FunScheduler::after(job, Timing::Seconds(1))
 
-----------------------------------------------------------------------
 
 .-{ seestem@protonmail.com ⧉ }-------------------------------------.
 | Written and placed in the public domain by Jackson G. Kaindume     |
diff --git a/src/lib.rs b/src/lib.rs
@@ -1,11 +1,7 @@
-// .---------------------------------------------------------------.
-// |           Written and placed in the public domain by           |
-// |        Jackson G. Kaindume<seestem@protonmail.com>  ⧉         |
-// '----------------------------------------------------------[2021]+
 //! # Time based function execution scheduler
-
 use std::time::Duration;
 
+/// Timing configuration
 pub enum Timing {
     Seconds(u64),
     Minutes(u64),
@@ -13,6 +9,7 @@ pub enum Timing {
     Days(u64),
 }
 
+/// Different methods/ways of running functions
 pub struct FunScheduler;
 
 impl FunScheduler {