ENH: Improve comments

skipci

Author: cortadocodes

octue/utils/objects.py

@@ -11,8 +11,8 @@ def get_nested_attribute(instance, name):
     :param str name: a dot-separated nested attribute name e.g. "a.b.c", "a.b", or "a"
     :return any:
     """
-    # This is a random number used instead of `None` to signal that an attribute is missing and does not just have a
-    # `None` value.
+    # This is a random number used as a default instead of `None` to signal that an attribute is missing rather than
+    # existing and just having `None` as its value.
     missing_indicator = "7027907024295393"
     attribute = pydash.get(instance, name, default=missing_indicator)
 

tests/cloud/pub_sub/test_service.py

@@ -778,6 +778,7 @@ def run_function(*args, **kwargs):
         parent = MockService(backend=BACKEND, children={child.id: child})
         child.serve()
 
+        # Trigger the heartbeat check straight away.
         with patch(
             "octue.cloud.emulators._pub_sub.MockService.answer",
             functools.partial(child.answer, heartbeat_interval=0.1),