Skip to content

Commit

Permalink
Update documentation in query/operators.py
Browse files Browse the repository at this point in the history
  • Loading branch information
rahul4732saini committed Jul 30, 2024
1 parent d70e009 commit 3db3a4d
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions fise/query/operators.py
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ def get_dataframe(
#### Params:
- fields (list[Field]): List of desired file metadata `Field` objects.
- columns (list[str]): List of columns names for the specified fields.
- condition (Callable): Function for filtering search records.
- condition (Callable): Function for filtering data records.
"""

files: Generator[File, None, None] = (
Expand All @@ -90,7 +90,7 @@ def remove_files(self, condition: Callable[[File], bool], skip_err: bool) -> Non
directory matching the specified condition.
#### Params:
- condition (Callable): Function for filtering search records.
- condition (Callable): Function for filtering data records.
- skip_err (bool): Whether to supress permission errors during operation.
"""

Expand Down Expand Up @@ -209,7 +209,7 @@ def get_dataframe(
#### Params:
- fields (list[str]): List of the desired metadata fields.
- condition (Callable): Function for filtering search records.
- condition (Callable): Function for filtering data records.
"""

# Generator object comprising search records of
Expand Down Expand Up @@ -267,7 +267,7 @@ def get_dataframe(
#### Params:
- fields (list[Field]): List of desired directory metadata `Field` objects.
- columns (list[str]): List of columns names for the specified fields.
- condition (Callable): Function for filtering search records.
- condition (Callable): Function for filtering data records.
"""

directories: Generator[Directory, None, None] = (
Expand All @@ -292,7 +292,7 @@ def remove_directories(
Removes all the subdirectories matching the specified condition.
#### Params:
- condition (Callable): Function for filtering directory records.
- condition (Callable): Function for filtering data records.
- skip_err (bool): Whether to supress permission errors during operation.
"""

Expand Down

0 comments on commit 3db3a4d

Please sign in to comment.