Add typing info to download_file() docstring

mediawiki-utilities · Sep 15, 2022 · 993577f · 993577f
1 parent 8c4b815
commit 993577f
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/src/mwsql/utils.py b/src/mwsql/utils.py
@@ -69,8 +69,11 @@ def download_file(url: str, file_name: str) -> Optional[Path]:
     """
     Download a file from a URL and show a progress indicator. Return the path to the downloaded file.
     :param url: URL to download from
+    :type url: str
     :param file_name: name of the file to download
+    type file_name: str
     :return: path to the downloaded file
+    :rtype: Optional[Path]
     """
 
     session = requests.Session()