From aa8c44a35a28d665a7bc85869a59e77f9ee9a7f9 Mon Sep 17 00:00:00 2001 From: "Brandon C. Irizarry" Date: Thu, 16 Apr 2026 16:33:26 -0400 Subject: docs: improve docstring That is, make it more accurate and specific. --- main.py | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) (limited to 'main.py') 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] = [] -- cgit v1.2.3