[+] Module docstrings and preconditions

2021-12-13 17:08:18 -05:00
parent 0744d1000e
commit fa0583007a
7 changed files with 43 additions and 9 deletions
@@ -162,7 +162,7 @@ def get_english_news_channels() -> list[str]:

    Run this after download_all_tweets(api, 'TwitterNews')

-    Precondition:
+    Preconditions:
      - <tweets_dir>/user/TwitterNews.json exists.

    :return: A list of news channel screen names
@@ -193,7 +193,7 @@ def filter_news_channels() -> None:
    """
    Filter out news channels that don't exist anymore or have been banned by Twitter.

-    Precondition:
+    Preconditions:
      - Run this after downloading all tweets from the news channels in Step 2.3 in main.

    :return: None