add: docstrings to rclone function, change arugment order

Author: shrey

datashuttle/datashuttle_class.py

@@ -1570,8 +1570,8 @@ def _setup_rclone_gdrive_config(
     ) -> None:
         rclone.setup_rclone_config_for_gdrive(
             self.cfg,
-            gdrive_client_secret,
             self.cfg.get_rclone_config_name("gdrive"),
+            gdrive_client_secret,
             config_token,
             log=log,
         )
@@ -1581,8 +1581,8 @@ def _setup_rclone_aws_config(
     ) -> None:
         rclone.setup_rclone_config_for_aws(
             self.cfg,
-            aws_secret_access_key,
             self.cfg.get_rclone_config_name("aws"),
+            aws_secret_access_key,
             log=log,
         )
 

datashuttle/utils/rclone.py

@@ -158,11 +158,34 @@ def setup_rclone_config_for_ssh(
 
 def setup_rclone_config_for_gdrive(
     cfg: Configs,
-    gdrive_client_secret: str | None,
     rclone_config_name: str,
+    gdrive_client_secret: str | None,
     config_token: Optional[str] = None,
     log: bool = True,
 ):
+    """
+    Sets up rclone config for connections to Google Drive. This must
+    contain the `gdrive_root_folder_id` and optionally a `gdrive_client_id`
+    which also mandates for the presence of a Google Drive client secret.
+
+    Parameters
+    ----------
+
+    cfg : Configs
+       datashuttle configs UserDict.
+
+    rclone_config_name : rclone config name
+         canonical config name, generated by
+         datashuttle.cfg.get_rclone_config_name()
+
+    gdrive_client_secret : Google Drive client secret, mandatory when
+        using a Google Drive client.
+
+    config_token : a token to setup rclone config without opening a browser,
+        needed if the user's machine doesn't have access to a browser.
+
+    log : whether to log, if True logger must already be initialised.
+    """
     client_id_key_value = (
         f"client_id {cfg['gdrive_client_id']} "
         if cfg["gdrive_client_id"]
@@ -202,10 +225,28 @@ def setup_rclone_config_for_gdrive(
 
 def setup_rclone_config_for_aws(
     cfg: Configs,
-    aws_secret_access_key: str,
     rclone_config_name: str,
+    aws_secret_access_key: str,
     log: bool = True,
 ):
+    """
+    Sets up rclone config for connections to AWS S3 buckets. This must
+    contain the `aws_access_key_id` and `aws_region`.
+
+    Parameters
+    ----------
+
+    cfg : Configs
+       datashuttle configs UserDict.
+
+    rclone_config_name : rclone config name
+         canonical config name, generated by
+         datashuttle.cfg.get_rclone_config_name()
+
+    aws_secret_access_key : the aws secret access key provided by the user.
+
+    log : whether to log, if True logger must already be initialised.
+    """
     output = call_rclone(
         "config create "
         f"{rclone_config_name} "