Conversation
SeunginLyu
left a comment
SeunginLyu
left a comment
There was a problem hiding this comment.
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.
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.
| sherlock_texts.close() | ||
|
|
||
| def process_line(line, hist): | ||
| line = line.replace('-', ' ') |
There was a problem hiding this comment.
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. |
2 participants
No description provided.