Connector Documentation (rusty1s#157)

* connector doc * typo
RexYing · Jan 11, 2022 · 8779ae2 · 8779ae2
1 parent 17fb7c7
commit 8779ae2
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 2 deletions.
diff --git a/kumo/connector/csv_connector.py b/kumo/connector/csv_connector.py
@@ -11,7 +11,12 @@
 
 
 class CSVConnector(Connector):
-    r"""Establishes a connection to a set of :obj:`*.csv` files."""
+    r"""Establishes a connection to a set of :obj:`*.csv` files.
+
+    Args:
+        root_dir (str): Root directory where :obj:`*.csv` files are stored.
+        **kwargs (optional): Additional arguments of :func:`pandas.read_csv`.
+    """
     def __init__(self, root_dir: str, **kwargs):
         if osp.exists(root_dir):
             root_dir = osp.expanduser(osp.normpath(root_dir))

diff --git a/kumo/connector/snowflake_connector.py b/kumo/connector/snowflake_connector.py
@@ -8,7 +8,16 @@
 
 class SnowflakeConnector(Connector):
     r"""Establishes a connection to a `Snowflake <https://www.snowflake.com/>`_
-    database."""
+    database.
+
+    Args:
+        account (str): The account name.
+        user (str): The user name.
+        password (str): The password.
+        warehouse (str): The name of the warehouse.
+        database (str): The name of the database.
+        schema (str): The name of the schema.
+    """
     def __init__(self, account: str, user: str, password: str, warehouse: str,
                  database: str, schema: str):
         self.account = account