From f7667538b0c94719e207611ad59f42386ad4ee01 Mon Sep 17 00:00:00 2001 From: MstrPikachu <31784486+MstrPikachu@users.noreply.github.com> Date: Mon, 13 Dec 2021 19:54:07 -0500 Subject: [PATCH] Add module docstring title to all files --- src/collect_others.py | 2 +- src/collect_twitter.py | 2 +- src/constants.py | 2 +- src/main.py | 2 +- src/processing.py | 2 +- src/report.py | 2 +- src/utils.py | 2 +- src/visualization.py | 2 +- 8 files changed, 8 insertions(+), 8 deletions(-) diff --git a/src/collect_others.py b/src/collect_others.py index e40d439..8af083a 100644 --- a/src/collect_others.py +++ b/src/collect_others.py @@ -1,4 +1,4 @@ -""" +"""CSC110 Fall 2021 Project This module uses web requests to collect and process other data we are using in our analysis. """ diff --git a/src/collect_twitter.py b/src/collect_twitter.py index 37744a0..589e049 100644 --- a/src/collect_twitter.py +++ b/src/collect_twitter.py @@ -1,4 +1,4 @@ -""" +"""CSC110 Fall 2021 Project This module interacts directly with the Twitter API to download tweets and users. It contains functions related scraping users/tweets, including: - getting the tweets of a user diff --git a/src/constants.py b/src/constants.py index cef8dcb..8d7dfae 100644 --- a/src/constants.py +++ b/src/constants.py @@ -1,4 +1,4 @@ -""" +"""CSC110 Fall 2021 Project This module stores constant variables in our projects. Instructors said that we can use global constants: https://piazza.com/class/ksovzjrlsye72f?cid=1664 diff --git a/src/main.py b/src/main.py index 31a22a2..290df72 100644 --- a/src/main.py +++ b/src/main.py @@ -1,4 +1,4 @@ -""" +"""CSC110 Fall 2021 Project This module is the main module of our program which runs different functions in different modules by steps. """ diff --git a/src/processing.py b/src/processing.py index 116da65..13bc889 100644 --- a/src/processing.py +++ b/src/processing.py @@ -1,4 +1,4 @@ -""" +"""CSC110 Fall 2021 Project Processes data downloaded from the Twitter API. Processing consists of calculating popularity of users, creating samples of users, filtering news channels, and processing tweets for file storage. """ diff --git a/src/report.py b/src/report.py index 1ab6d96..d64aaca 100644 --- a/src/report.py +++ b/src/report.py @@ -1,4 +1,4 @@ -""" +"""CSC110 Fall 2021 Project This module generates report HTML and serves it in an HTTP server. """ diff --git a/src/utils.py b/src/utils.py index 32cd931..4779aba 100644 --- a/src/utils.py +++ b/src/utils.py @@ -1,4 +1,4 @@ -""" +"""CSC110 Fall 2021 Project This module contains useful functions and classes, including: - debug messages - file I/O diff --git a/src/visualization.py b/src/visualization.py index 9c4fb18..2c71051 100644 --- a/src/visualization.py +++ b/src/visualization.py @@ -1,4 +1,4 @@ -""" +"""CSC110 Fall 2021 Project This module uses matplotlib to visualize processed data as graphs. The results are stored in report directory. The graphs are created after processing the data, for example with filtering and removing outliers.