prepare for release 2.0.4

inky_run.py

@@ -8,24 +8,8 @@ import asyncio
 from inkycal import Inkycal
 
 
-async def dry_run():
-    # create an instance of Inkycal
-    # If your settings.json file is not in /boot, use the full path:
-    # inky = Inkycal('path/to/settings.json', render=True)
-    inky = Inkycal(render=False)
-    await inky.run(run_once=True)  # dry-run without rendering anything on the display
-
-
-async def clear_display():
-    print("loading Inkycal and display driver...")
-    inky = Inkycal(render=True)  # Initialise Inkycal
-    print("clearing display...")
-    inky.calibrate(cycles=1)  # Calibrate the display
-    print("clear complete...")
-    print("finished!")
-
-
 async def run():
+    """Run Inkycal nonstop. Default mode."""
     # create an instance of Inkycal
     # If your settings.json file is not in /boot, use the full path:
     # inky = Inkycal('path/to/settings.json', render=True)
@@ -36,5 +20,24 @@ async def run():
     await inky.run()  # If there were no issues, you can run Inkycal nonstop
 
 
+async def dry_run():
+    """Useful for checking if the settings.json file is okay, without actually touching the display"""
+    # create an instance of Inkycal
+    # If your settings.json file is not in /boot, use the full path:
+    # inky = Inkycal('path/to/settings.json', render=True)
+    inky = Inkycal(render=False)
+    await inky.run(run_once=True)  # dry-run without rendering anything on the display
+
+
+async def clear_display():
+    """Calibrate the display if you see some ghosting"""
+    print("loading Inkycal and display driver...")
+    inky = Inkycal(render=True)  # Initialise Inkycal
+    print("clearing display...")
+    inky.calibrate(cycles=1)  # Calibrate the display
+    print("clear complete...")
+    print("finished!")
+
+
 if __name__ == "__main__":
     asyncio.run(run())