splitting alarm into multiple files

CohenLabPrinceton · Aug 17, 2020 · bd56bc8 · bd56bc8
1 parent df712eb
commit bd56bc8
Show file tree

Hide file tree

Showing 6 changed files with 37 additions and 35 deletions.
diff --git a/_docs/alarm.alarm.rst b/_docs/alarm.alarm.rst
@@ -0,0 +1,7 @@
+Alarm Objects
+================
+
+.. automodule:: pvp.alarm.alarm
+    :members:
+    :undoc-members:
+    :autosummary:
diff --git a/_docs/alarm.alarm_manager.rst b/_docs/alarm.alarm_manager.rst
@@ -0,0 +1,7 @@
+Alarm Manager
+================
+
+.. automodule:: pvp.alarm.alarm_manager
+    :members:
+    :undoc-members:
+    :autosummary:
diff --git a/_docs/alarm.alarm_rule.rst b/_docs/alarm.alarm_rule.rst
@@ -0,0 +1,7 @@
+Alarm Rule
+============
+
+.. automodule:: pvp.alarm.rule
+    :members:
+    :undoc-members:
+    :autosummary:
diff --git a/_docs/alarm.condition.rst b/_docs/alarm.condition.rst
@@ -0,0 +1,7 @@
+Alarm Condition
+===================
+
+.. automodule:: pvp.alarm.condition
+    :members:
+    :undoc-members:
+    :autosummary:
diff --git a/_docs/alarm.rst b/_docs/alarm.rst
@@ -1,4 +1,4 @@
-alarm
+Alarm
 ==========
 
 Main Alarm Module
@@ -9,36 +9,6 @@ Main Alarm Module
     :undoc-members:
     :autosummary:
 
-Alarm Manager
-----------------
-
-.. automodule:: pvp.alarm.alarm_manager
-    :members:
-    :undoc-members:
-    :autosummary:
-
-Alarm
-------------
-
-.. automodule:: pvp.alarm.alarm
-    :members:
-    :undoc-members:
-    :autosummary:
-
-Condition
------------
-
-.. automodule:: pvp.alarm.condition
-    :members:
-    :undoc-members:
-    :autosummary:
-
-Alarm Rule
------------
 
-.. automodule:: pvp.alarm.rule
-    :members:
-    :undoc-members:
-    :autosummary:
 
 
diff --git a/pvp/common/values.py b/pvp/common/values.py
@@ -57,9 +57,6 @@ def __init__(self,
                  group: typing.Union[None, dict] = None,
                  default: (int, float) = None):
         """
-        Definition of a value.
-
-        Used by the GUI and control module to set defaults.
 
         Args:
             name (str): Human-readable name of the value
@@ -314,7 +311,14 @@ def __setitem__(self, key, value):
     def __getitem__(self, key):
         return self.__getattribute__(key)
 
-    def to_dict(self):
+    def to_dict(self) -> dict:
+        """
+        Gather up all attributes and return as a dict!
+
+        Returns:
+            dict
+        """
+
         return {
             'name': self.name,
             'units': self.units,