Added a comment to hal_sleep_us function

davehylands · davehylands · commit 69251c2b9fff · 2021-08-27T11:28:56.000-07:00
diff --git a/lcd/lcd_api.py b/lcd/lcd_api.py
@@ -203,6 +203,10 @@ def hal_write_data(self, data):
         """
         raise NotImplementedError
 
+    # This is a default implementation of hal_sleep_us which is suitable
+    # for most micropython implementations. For platforms which don't
+    # support `time.sleep_us()` they should provide their own implementation
+    # of hal_sleep_us in their hal layer and it will be used instead.
     def hal_sleep_us(self, usecs):
         """Sleep for some time (given in microseconds)."""
         time.sleep_us(usecs)  # NOTE this is not part of Standard Python library, specific hal layers will need to override this
