update docs

mjishnu · Nov 18, 2023 · 805756d · 805756d
1 parent 26e6552
commit 805756d
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -162,7 +162,7 @@ The `Downloader` class represents a file downloader that can download a file fro
 
 -   `start(url, filepath, num_connections=10, display=True, multithread=True, block=True, retries=0, retry_func=None)`: Starts the download process. Parameters:
     -   `url` (str): The download URL.
-    -   `filepath` (str): The file path to save the download.
+    -   `filepath` (str):  The optional file path to save the download. by default it uses the present working directory, If filepath a is directory then the file is downloaded into the it else the file is downloaded with the given name.
     -   `num_connections` (int): The number of connections to use for a multi-threaded download.
     -   `display` (bool): Whether to display download progress.
     -   `multithread` (bool): Whether to use multi-threaded download.

diff --git a/pypdl/main.py b/pypdl/main.py
@@ -323,8 +323,8 @@ def start(
 
         Parameters:
             url (str): The download URL.
-            filepath (str): The optional file path to save the download.
-                If it is directory or None then filepath is appended with file name.
+            filepath (str): The optional file path to save the download. by default it uses the present working directory,
+                If filepath a is directory then the file is downloaded into the it else the file is downloaded with the given name.
             num_connections (int): The number of connections to use for a multi-threaded download.
             display (bool): Whether to display download progress.
             multithread (bool): Whether to use multi-threaded download.