fix docstring of reader.py

Author: HydrogenSulfate

ppsci/data/dataset/csv_dataset.py

@@ -36,12 +36,13 @@ class CSVDataset(io.Dataset):
         input_keys (Tuple[str, ...]): List of input keys.
         label_keys (Tuple[str, ...]): List of label keys.
         alias_dict (Optional[Dict[str, str]]): Dict of alias(es) for input and label keys.
+            i.e. {inner_key: outer_key}. Defaults to None.
         weight_dict (Optional[Dict[str, Union[Callable, float]]]): Define the weight of
             each constraint variable. Defaults to None.
         timestamps (Optional[Tuple[float, ...]]): The number of repetitions of the data
             in the time dimension. Defaults to None.
         transforms (Optional[vision.Compose]): Compose object contains sample wise
-            transform(s).
+            transform(s). Defaults to None.
 
     Examples:
         >>> import ppsci
@@ -154,12 +155,13 @@ class IterableCSVDataset(io.IterableDataset):
         input_keys (Tuple[str, ...]): List of input keys.
         label_keys (Tuple[str, ...]): List of label keys.
         alias_dict (Optional[Dict[str, str]]): Dict of alias(es) for input and label keys.
+            Defaults to None.
         weight_dict (Optional[Dict[str, Union[Callable, float]]]): Define the weight of
             each constraint variable. Defaults to None.
         timestamps (Optional[Tuple[float, ...]]): The number of repetitions of the data
             in the time dimension. Defaults to None.
         transforms (Optional[vision.Compose]): Compose object contains sample wise
-            transform(s).
+            transform(s). Defaults to None.
 
     Examples:
         >>> import ppsci

ppsci/data/dataset/mat_dataset.py

@@ -36,12 +36,13 @@ class MatDataset(io.Dataset):
         input_keys (Tuple[str, ...]): List of input keys.
         label_keys (Tuple[str, ...]): List of label keys.
         alias_dict (Optional[Dict[str, str]]): Dict of alias(es) for input and label keys.
+            i.e. {inner_key: outer_key}. Defaults to None.
         weight_dict (Optional[Dict[str, Union[Callable, float]]]): Define the weight of
             each constraint variable. Defaults to None.
         timestamps (Optional[Tuple[float, ...]]): The number of repetitions of the data
             in the time dimension. Defaults to None.
         transforms (Optional[vision.Compose]): Compose object contains sample wise
-            transform(s).
+            transform(s). Defaults to None.
 
     Examples:
         >>> import ppsci
@@ -154,12 +155,13 @@ class IterableMatDataset(io.IterableDataset):
         input_keys (Tuple[str, ...]): List of input keys.
         label_keys (Tuple[str, ...]): List of label keys.
         alias_dict (Optional[Dict[str, str]]): Dict of alias(es) for input and label keys.
+            i.e. {inner_key: outer_key}. Defaults to None.
         weight_dict (Optional[Dict[str, Union[Callable, float]]]): Define the weight of
             each constraint variable. Defaults to None.
         timestamps (Optional[Tuple[float, ...]]): The number of repetitions of the data
             in the time dimension. Defaults to None.
         transforms (Optional[vision.Compose]): Compose object contains sample wise
-            transform(s).
+            transform(s). Defaults to None.
 
     Examples:
         >>> import ppsci

ppsci/geometry/pointcloud.py

@@ -30,7 +30,7 @@ class PointCloud(geometry.Geometry):
         coord_keys (Tuple[str, ...]): Tuple of coordinate keys, such as ("x", "y").
         boundary_path (Optional[str]): File which store boundary points of a point cloud. Defaults to None.
         boundary_normal_path (Optional[str]): File which store boundary normals of a point cloud. Defaults to None.
-        alias_dict (Optional[Dict[str, str]]): Alias name for coord key, such as {"X:0": "x", "X:1": "y"}. Defaults to None.
+        alias_dict (Optional[Dict[str, str]]): Alias name for coord key, such as {"x": "X:0", "y": "X:1"}. Defaults to None.
 
     Examples:
         >>> import ppsci

ppsci/utils/reader.py

@@ -38,7 +38,7 @@ def load_csv_file(
         file_path (str): CSV file path.
         keys (Tuple[str, ...]): Required fetching keys.
         alias_dict (Optional[Dict[str, str]]): Alias for keys,
-            i.e. {original_key: original_key}. Defaults to None.
+            i.e. {inner_key: outer_key}. Defaults to None.
         encoding (str, optional): Encoding code when open file. Defaults to "utf-8".
 
     Returns: