From f183f792f8bdf62738f3571869b1d263b99d358f Mon Sep 17 00:00:00 2001 From: Philip Meier Date: Tue, 16 Mar 2021 09:47:27 +0100 Subject: [PATCH] add explanation for injected fake data in dataset tests --- test/datasets_utils.py | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/test/datasets_utils.py b/test/datasets_utils.py index db5a37d98d5..ad700a717a7 100644 --- a/test/datasets_utils.py +++ b/test/datasets_utils.py @@ -266,6 +266,10 @@ def dataset_args(self, tmpdir: str, config: Dict[str, Any]) -> Sequence[Any]: def inject_fake_data(self, tmpdir: str, config: Dict[str, Any]) -> Union[int, Dict[str, Any]]: """Inject fake data for dataset into a temporary directory. + During the creation of the dataset the download and extract logic is disabled. Thus, the fake data injected + here needs to resemble the raw data, i.e. the state of the dataset directly after the files are downloaded and + potentially extracted. + Args: tmpdir (str): Path to a temporary directory. For most cases this acts as root directory for the dataset to be created and in turn also for the fake data injected here.