Clean up NetTime

Sources/NetTime/Date+NetTime.swift

@@ -3,8 +3,8 @@ import Logger
 /**
  * - Description: class which will provide the best estimate of the difference in time between the device's system clock and the time returned by a collection of time servers
  * - Note: This class has Unit-tests
- * - Fixme: ⚠️️ If you want to sync your time to a specific server (e.g. your API server).
- * - Fixme: ⚠️️ If for some reason the Date format your HTTP Server returns is different than the one specified.
+ * - Fixme: ⚠️️ If you want to sync your time to a specific server (e.g. your API server)
+ * - Fixme: ⚠️️ If for some reason the Date format your HTTP Server returns is different than the one specified
  * ## Examples:
  *  Date.updateTime { // Call when app launches etc
  *     print("☀️ Current Date: \(Date().formatted())")
@@ -30,7 +30,7 @@ extension Date {
     * - Remark: Set this at the first opertunity when using the app
     * - Remark: Call this on background queue
     * - Remark: If this is not called e use system time
-    * - Fixme: ⚠️️ Add error to `onComplete` closure, use Result maybe? 👈
+    * - Fixme: ⚠️️ Add error to `onComplete` closure, use Result maybe? 👈 This way we can log the error in the caller etc
     * - Parameter onComplete: Callback when server has responded
     */
    public static func updateTime(onComplete: @escaping OnComplete = defaultOnComplete) {

Tests/NetTimeTests/util/Date+TimeZone.swift

@@ -1,5 +1,8 @@
 import Foundation
-// Fix: im not sure we use this anymore as we jsut use UTC, maybe move to a gist?
+/**
+ * - Fixme: ⚠️️ I'm not sure we use this anymore as we just use UTC, maybe move to a gist?
+ * - Fixme: ⚠️️ I guess we convert back to the users timezone in the presentation layer, so maybe keep around?
+ */
 extension TimeZone {
    /**
     * The Central European Time (CET) time zone.
@@ -55,7 +58,7 @@ extension Date {
       return self.convert(from: TimeZone.current, to: timeZone) // Convert date from current time zone to specified time zone
    }
    /**
-    * Converts the date from one time zone to another.
+    * Converts the date from one time zone to another
     * - Parameters:
     *   - timeZone: The time zone of the original date.
     *   - destinationTimeZone: The time zone to convert the date to.

Tests/NetTimeTests/util/Reachability.swift

@@ -6,11 +6,10 @@ internal class Reachability {
     * - Note: The reason why we do async: https://stackoverflow.com/a/40764725/5389500
     * - Parameters:
     *   - completionHandler: The closure to call with the result of the network check.
-    *
     * ## Example:
     * Self.checkNetwork { Swift.print("Net: \($0)") }
     * - Fixme: ⚠️️ Add result? to print error etc? or just throw error?
-    * - Fixme: ⚠️️ Add semaphore with timeout as well, or add timeout some other way?
+    * - Fixme: ⚠️️ Add semaphore with timeout as well, or add timeout some other way? Check with copilots
     */
    internal static func checkNetwork(completionHandler: @escaping (_ internet: Bool) -> Void) {
       guard let url: URL = .init(string: "https://www.google.com/") else { completionHandler(false); return; } // Create a URL object for Google's homepage

Tests/NetTimeTests/util/TimeMeasure.swift

@@ -11,9 +11,9 @@ internal final class TimeMeasure {
    internal typealias Operation = () throws -> Void 
    /**
     * Measures how long a closure takes to complete
-    * - Note: Great for UnitTesting
-    * - Note: it's also possible to use. let startTime = CFAbsoluteTimeGetCurrent(); CFAbsoluteTimeGetCurrent() - startTime
-    * fix: add param comment
+    * - Note: This method is great for UnitTesting
+    * - Note: it's also possible to use. `let startTime = CFAbsoluteTimeGetCurrent(); CFAbsoluteTimeGetCurrent() - startTime`
+    * - Fixme: ⚠️️ Add param comment
     * ## Examples:
     * print("\(timeElapsed { sleep(2.2) })") // 2.20000
     */

readme.md

@@ -61,3 +61,7 @@ Contributions are welcome! Please read our [contributing guidelines](CONTRIBUTIN
 ## License
 
 NetTime is released under the MIT License. See [LICENSE](LICENSE) for details.
+
+## Todo:
+- Do more exploration into side-effects
+- Comb the competitors for ways to improve