Fix sync_folder docstring (#460)

This commit is contained in:
pollfly 2021-09-23 16:53:11 +03:00 committed by GitHub
parent 80e6ca6406
commit 1cb5dbb276
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -247,8 +247,8 @@ class Dataset(object):
def sync_folder(self, local_path, dataset_path=None, verbose=False): def sync_folder(self, local_path, dataset_path=None, verbose=False):
# type: (Union[Path, _Path, str], Union[Path, _Path, str], bool) -> (int, int) # type: (Union[Path, _Path, str], Union[Path, _Path, str], bool) -> (int, int)
""" """
Synchronize the dataset with a local folder. The dataset is synchronized from the Synchronize the dataset with a local folder. The dataset is synchronized recursively from the `local_path` into
relative_base_folder (default: dataset root) and deeper with the specified local path. the `dataset_path` (default: dataset root).
:param local_path: Local folder to sync (assumes all files and recursive) :param local_path: Local folder to sync (assumes all files and recursive)
:param dataset_path: Target dataset path to sync with (default the root of the dataset) :param dataset_path: Target dataset path to sync with (default the root of the dataset)