From 5f9219acf252836d92c47945063116a0a6a06a45 Mon Sep 17 00:00:00 2001
From: Linlang <Lv.Linlang@hotmail.com>
Date: Thu, 23 May 2024 20:47:32 +0800
Subject: [PATCH] add comments

---
 qlib/tests/data.py | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/qlib/tests/data.py b/qlib/tests/data.py
index 7fedb56d0a..2fa76855b5 100644
--- a/qlib/tests/data.py
+++ b/qlib/tests/data.py
@@ -29,6 +29,16 @@ def __init__(self, delete_zip_file=False):
         self.delete_zip_file = delete_zip_file
 
     def merge_remote_url(self, file_name: str):
+        """
+        Generate download links.
+
+        Parameters
+        ----------
+        file_name: str
+            The name of the file to be downloaded.
+            The file name can be accompanied by a version number, (e.g.: v2/qlib_data_simple_cn_1d_latest.zip),
+            if no version number is attached, it will be downloaded from v0 by default.
+        """
         return f"{self.REMOTE_URL}/{file_name}" if "/" in file_name else f"{self.REMOTE_URL}/v0/{file_name}"
 
     def download(self, url: str, target_path: [Path, str]):