requested changes

aeye-lab · Sep 22, 2023 · 6de384b · 6de384b
1 parent 0837f19
commit 6de384b
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 8 deletions.
diff --git a/src/pymovements/datasets/__init__.py b/src/pymovements/datasets/__init__.py
@@ -29,7 +29,6 @@
     pymovements.datasets.GazeBaseVR
     pymovements.datasets.GazeOnFaces
     pymovements.datasets.JuDo1000
-    pymovements.datasets.GazeOnFaces
 
 
 .. rubric:: Example Datasets
@@ -41,9 +40,9 @@
     pymovements.datasets.ToyDataset
     pymovements.datasets.ToyDatasetEyeLink
 """
-from pymovements.datasets.gaze_on_faces import GazeOnFaces
 from pymovements.datasets.gazebase import GazeBase
 from pymovements.datasets.gazebasevr import GazeBaseVR
+from pymovements.datasets.gaze_on_faces import GazeOnFaces
 from pymovements.datasets.judo1000 import JuDo1000
 from pymovements.datasets.toy_dataset import ToyDataset
 from pymovements.datasets.toy_dataset_eyelink import ToyDatasetEyeLink
@@ -54,7 +53,6 @@
     'GazeBaseVR',
     'GazeOnFaces',
     'JuDo1000',
-    'GazeOnFaces',
     'ToyDataset',
     'ToyDatasetEyeLink',
 ]
diff --git a/src/pymovements/gaze/io.py b/src/pymovements/gaze/io.py
@@ -163,7 +163,7 @@ def from_csv(
 def from_ipc(
         file: str | Path,
         experiment: Experiment | None = None,
-        **read_csv_kwargs: Any,
+        **read_ipc_kwargs: Any,
 ) -> GazeDataFrame:
     """Initialize a :py:class:`pymovements.gaze.gaze_dataframe.GazeDataFrame`.
 
@@ -173,14 +173,14 @@ def from_ipc(
         Path of IPC/feather file.
     experiment : Experiment
         The experiment definition.
-    **read_csv_kwargs:
-            Additional keyword arguments to be passed to polars to read in the csv.
+    **read_ipc_kwargs:
+            Additional keyword arguments to be passed to polars to read in the ipc file.
 
     Examples
     --------
     First let's assume a IPC file stored `tests/gaze/io/files/monocular_example.feather`
 
-    We can now load the data into a ``GazeDataFrame`` by specyfing the experimental setting
+    We can now load the data into a ``GazeDataFrame``
 
     >>> from pymovements.gaze.io import from_ipc
     >>> gaze = from_ipc(
@@ -206,7 +206,7 @@ def from_ipc(
 
     """
     # read data
-    gaze_data = pl.read_ipc(file, **read_csv_kwargs)
+    gaze_data = pl.read_ipc(file, **read_ipc_kwargs)
 
     # create gaze data frame
     gaze_df = GazeDataFrame(