add node docstring to service and resource classes

oresat · Dec 12, 2023 · 3e2b494 · 3e2b494
1 parent bb6f0d8
commit 3e2b494
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 0 deletions.
diff --git a/olaf/common/resource.py b/olaf/common/resource.py
@@ -14,6 +14,7 @@ class Resource:
 
     def __init__(self):
         self.node = None
+        """Node or MasterNode: The app's CANopen node. Set to None until start() is called."""
 
     def start(self, node: Node):
         """

diff --git a/olaf/common/service.py b/olaf/common/service.py
@@ -32,6 +32,8 @@ class Service:
 
     def __init__(self):
         self.node = None
+        """Node or MasterNode: The app's CANopen node. Set to None until start() is called."""
+
         self._event = Event()
         self._thread = Thread(target=self._loop)
         self._status = ServiceState.STOPPED