finish a first pitch of docstrings

corrlib/main.py

@@ -45,9 +45,25 @@ def create_project(path: str, uuid: str, owner: Union[str, None]=None, tags: Uni
     conn.commit()
     conn.close()
     save(path, message="Added entry for project " + uuid + " to database", files=[db_file])
+    return
 
 
 def update_project_data(path: str, uuid: str, prop: str, value: Union[str, None] = None) -> None:
+    """
+    Update/Edit a project entry in the database.
+    Thin wrapper around sql3 call.
+
+    Parameters
+    ----------
+    path: str
+        The path to the backlogger folder.
+    uuid: str
+        The uuid of the project.
+    prop: str
+        Property of the entry to edit
+    value: str or None
+        Value to se `prop` to.
+    """
     db_file = get_db_file(path)
     get(path, db_file)
     conn = sqlite3.connect(os.path.join(path, db_file))
@@ -88,6 +104,8 @@ def update_aliases(path: str, uuid: str, aliases: list[str]) -> None:
 
 def import_project(path: str, url: str, owner: Union[str, None]=None, tags: Optional[list[str]]=None, aliases: Optional[list[str]]=None, code: Optional[str]=None, isDataset: bool=True) -> str:
     """
+    Import a datalad dataset into the backlogger.
+
     Parameters
     ----------
 
@@ -95,22 +113,19 @@ def import_project(path: str, url: str, owner: Union[str, None]=None, tags: Opti
         The url of the project to import. This can be any url that datalad can handle.
     path: str
         The path to the backlogger folder.
-    aliases: list[str]
-        Custom name of the project, alias of the project.
-    code: str
+    owner: str, optional
+        Person responsible for the maintainance of the project to be impoerted.
+    tags: list[str], optional
+        Custom tags of the imported project.
+    aliases: list[str], optional
+        Custom names of the project, alias of the project.
+    code: str, optional
         Code that was used to create the measurements.
 
-    Import a datalad dataset into the backlogger.
-
-    Parameters
-    ----------
-    path: str
-        The path to the backlogger directory.
-    url: str
-        The url of the project to import. This can be any url that datalad can handle.
-        Also supported are non-datalad datasets, which will be converted to datalad datasets,
-        in order to receive a uuid and have a consistent interface.
-
+    Returns
+    -------
+    uuid: str
+        The unique identifier of the imported project.
     """
     tmp_path = os.path.join(path, 'projects/tmp')
     clone(path, source=url, target=tmp_path)
@@ -144,6 +159,15 @@ def import_project(path: str, url: str, owner: Union[str, None]=None, tags: Opti
 def drop_project_data(path: str, uuid: str, path_in_project: str = "") -> None:
     """
     Drop (parts of) a project to free up diskspace
+
+    Parameters
+    ----------
+    path: str
+        Path of the library.
+    uuid: str
+        The UUID ofthe project rom which data is to be dropped.
+    path_pn_project: str, optional
+        If set, only the given path within the project is dropped.
     """
     drop(path + "/projects/" + uuid + "/" + path_in_project)
     return