Commenting

Making the numpydoc consistent.

No longer provide examples, declare attributes, etc.

Author: AdvancedImagingUTSW

src/navigate/config/config.py

@@ -54,11 +54,6 @@ def get_navigate_path():
     -------
     str
         Path to Navigate home directory.
-
-    Examples
-    --------
-    >>> get_navigate_path()
-    'C:\\Users\\username\\AppData\\Local\\.navigate'
     """
     if platform.system() == "Windows":
         base_directory = os.getenv("LOCALAPPDATA")
@@ -170,14 +165,6 @@ def build_nested_dict(manager, parent_dict, key_name, dict_data):
         Name of dictionary to insert
     dict_data : dict
         Dictionary to insert
-
-    Returns
-    -------
-    None
-
-    Examples
-    --------
-    >>> build_nested_dict(manager, parent_dict, key_name, dict_data)
     """
     if type(dict_data) != dict and type(dict_data) != list:
         parent_dict[key_name] = dict_data
@@ -213,10 +200,6 @@ def update_config_dict(manager, parent_dict, config_name, new_config) -> bool:
     -------
     bool
         True or False
-
-    Examples
-    --------
-    >>> update_config_dict(manager, parent_dict, config_name, new_config)
     """
     if type(new_config) != dict and type(new_config) != list:
         file_path = str(new_config)
@@ -1096,4 +1079,3 @@ def verify_configuration(manager, configuration):
         "gui",
         {"channels": {"count": channel_count}},
     )
-

src/navigate/model/plugins_model.py

@@ -37,7 +37,7 @@
 # Third-party imports
 
 # Local application imports
-from navigate.tools.file_functions import load_yaml_file, save_yaml_file
+from navigate.tools.file_functions import save_yaml_file
 from navigate.tools.decorators import FeatureList, AcquisitionMode
 from navigate.config.config import get_navigate_path
 from navigate.plugins.plugin_manager import PluginFileManager, PluginPackageManager
@@ -102,7 +102,7 @@ def load_plugins_through_manager(self, plugin_manager):
             plugin_manager.load_devices(plugin_ref, self.register_device)
 
     def register_device(self, device, module):
-        """Regiseter device
+        """Register device
 
         Parameters
         ----------

src/navigate/plugins/plugin_manager.py

@@ -58,6 +58,8 @@ def register_features(module):
 
 
 class PluginPackageManager:
+    """Plugin package manager"""
+
     @staticmethod
     def get_plugins():
         """Get plugins
@@ -227,7 +229,10 @@ def load_devices(package_name, register_func):
             [importlib.resources.files(package_name).joinpath("model/devices")]
         ):
             if is_pkg:
-                full_module_name = f"{package_name}.model.devices.{module_name}.device_startup_functions"
+                full_module_name = (
+                    f"{package_name}.model."
+                    f"devices.{module_name}.device_startup_functions"
+                )
                 try:
                     module = importlib.import_module(full_module_name)
                 except (ImportError, AttributeError):
@@ -236,8 +241,23 @@ def load_devices(package_name, register_func):
 
 
 class PluginFileManager:
+    """Plugin file manager"""
+
     def __init__(self, plugins_path, plugins_config_path):
+        """Initialize PluginFileManager
+
+        Parameters
+        ----------
+        plugins_path : str
+            plugins path
+        plugins_config_path : str
+            plugins config path
+        """
+
+        #: str: plugins path
         self.plugins_path = plugins_path
+
+        #: str: plugins config path
         self.plugins_config_path = plugins_config_path
 
     def get_plugins(self):