Skip to content

Conversation

@leoliuuu
Copy link

No description provided.

Copy link

@SeunginLyu SeunginLyu left a 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

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.

sherlock_texts.close()

def process_line(line, hist):
line = line.replace('-', ' ')

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.

@SeunginLyu
Copy link

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants