summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBrandon C. Irizarry <brandon.irizarry@gmail.com>2026-04-16 16:33:26 -0400
committerBrandon C. Irizarry <brandon.irizarry@gmail.com>2026-04-16 16:33:26 -0400
commitaa8c44a35a28d665a7bc85869a59e77f9ee9a7f9 (patch)
treec4cb7d2a500c8c06e3a78628c238a47da3ca861d
parent04990b33de1b24e9904b35a9563d5aaf37c5bf7d (diff)
docs: improve docstring
That is, make it more accurate and specific.
-rw-r--r--main.py8
1 files changed, 5 insertions, 3 deletions
diff --git a/main.py b/main.py
index c0a62af..463b5df 100644
--- a/main.py
+++ b/main.py
@@ -5,13 +5,15 @@ import sys
def get_urls(filename: str, limit: int | None = None) -> list[str]:
"""Get a list of URLs from FILENAME.
- FILENAME should be that of a CSV file with a field 'Domain'
- denoting the site
+ FILENAME should be that of a CSV file with a field 'Domain',
+ denoting the site URL.
- The https schema is prefixed to each URL.
+ The 'https://' schema is prefixed to each URL.
If LIMIT is not None, then stop after LIMIT URLs have been read.
+ Return the list of URLs.
+
"""
urls: list[str] = []