Format docstrings

src/primaite/setup/reset_demo_notebooks.py

@@ -12,11 +12,9 @@ _LOGGER = getLogger(__name__)
 
 
 def run(overwrite_existing: bool = True):
-    """
-    Resets the demo jupyter notebooks in the users app notebooks directory.
+    """Resets the demo jupyter notebooks in the users app notebooks directory.
 
-    :param overwrite_existing: A bool to toggle replacing existing edited
-        notebooks on or off.
+    :param overwrite_existing: A bool to toggle replacing existing edited notebooks on or off.
     """
     notebooks_package_data_root = pkg_resources.resource_filename("primaite", "notebooks/_package_data")
     for subdir, dirs, files in os.walk(notebooks_package_data_root):

src/primaite/setup/reset_example_configs.py

@@ -11,11 +11,9 @@ _LOGGER = getLogger(__name__)
 
 
 def run(overwrite_existing=True):
-    """
-    Resets the example config files in the users app config directory.
+    """Resets the example config files in the users app config directory.
 
-    :param overwrite_existing: A bool to toggle replacing existing edited
-        config on or off.
+    :param overwrite_existing: A bool to toggle replacing existing edited config on or off.
     """
     configs_package_data_root = pkg_resources.resource_filename("primaite", "config/_package_data")
 

src/primaite/setup/setup_app_dirs.py

@@ -5,8 +5,7 @@ _LOGGER = getLogger(__name__)
 
 
 def run():
-    """
-    Handles creation of application directories and user directories.
+    """Handles creation of application directories and user directories.
 
     Uses `platformdirs.PlatformDirs` and `pathlib.Path` to create the required
     app directories in the correct locations based on the users OS.