Add docstring

src/pandas_utility.py

@@ -5,10 +5,23 @@ import ast
 from abc import ABC, abstractmethod
 from typing import List, Any
 
-def read_csv_df(read_path: str, header=0) -> pd.DataFrame:
+def read_csv_df(read_path: str, header: int = 0) -> pd.DataFrame:
     """
-    データフレームを読み込むメソッド
-    ついでに文字列として読み込まれるリストをリストに戻す
+    csv形式のデータフレームの読み込み
+
+    文字列として読み込まれたリストの復元も行う
+
+    Parameters
+    ----------
+    read_path : str
+        データフレームが保存されているパス
+    header : int, optional
+        ヘッダーとする行の指定, by default 0
+
+    Returns
+    -------
+    pd.DataFrame
+        データフレーム
     """
     df = pd.read_csv(read_path, header=header)
 
@@ -18,7 +31,23 @@ def read_csv_df(read_path: str, header=0) -> pd.DataFrame:
 
     return df
 
-def check_lst_col(value: str):
+
+def check_lst_col(value: str) -> bool:
+    """
+    リストの列の確認
+
+    元の値がリストだった列の確認
+
+    Parameters
+    ----------
+    value : str
+        その列の代表の値
+
+    Returns
+    -------
+    bool
+        その列の値がリストならTrue、リストでなければFalse
+    """
     # 数値に、インデックスで最初の文字を指定するとエラーになる
     is_str = isinstance(value, str)
 
@@ -31,11 +60,23 @@ def check_lst_col(value: str):
 
     return is_lst_col
 
-# データフレームをcsvで保存するメソッド
-def save_csv_df(df, file_name: str, save_dir: str) -> None:
+
+def save_csv_df(df: pd.DataFrame, file_name: str, save_dir: str) -> None:
+    """
+    csv形式でのデータフレームの保存
+
+    Parameters
+    ----------
+    df : pd.DataFrame
+        保存するデータフレーム
+    file_name : str
+        保存するデータフレームのファイル名
+    save_dir : str
+        データフレームの保存先ディレクトリ
+    """
     df.to_csv(f'{save_dir}/{file_name}.csv', index=False)
 
-# 指定した行の指定した列の値の更新に関与するメソッド及びカスタムエラークラス
+
 class CustomError(Exception, ABC):
     """
     カスタムエラーの基底クラス