-
Notifications
You must be signed in to change notification settings - Fork 16
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
MiniProject 3 TextMining #9
base: master
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good job! Your code is concise and it looks like they achieve your goal. However, it is difficult for a reviewer to get a quick sense of what each function is doing because there are no docstrings. Please add docstrings for your revision.
TextMining.py
Outdated
import random | ||
from vaderSentiment.vaderSentiment import SentimentIntensityAnalyzer | ||
|
||
#data file downloaded once, text has been saved through pickle |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You can use """ comments """
instead of putting #
for every line of code. This is called the header comment. It usually contains brief description of the code, just like what you've written here.
TextMining.py
Outdated
sherlock_texts.close() | ||
|
||
def process_line(line, hist): | ||
line = line.replace('-', ' ') |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
please add docstrings for all the functions you write. You can take a look at the google style used here: https://github.com/sd17fall/GeneFinder/blob/formatted/gene_finder.py.
I can't not figure out what this function is doing unless I go read every line. When the code gets longer, having no docstrings is really frustrating to the reviewer.
Good! Now I see documentation for your functions. I suggest using the style Oliver used in https://github.com/sd17fall/GeneFinder/blob/formatted/gene_finder.py for better readability. |
No description provided.