thisandagain/sentiment

Improve documentation

Closed this issue · 4 comments

thisandagain commented

Related to #111 #107

  • Briefly describe the approach taken by AFINN
  • Briefly describe the how the tokenizer works
  • Briefly describe each property of the returned object
rishpandey commented

Should this be added to README or use separate file?

thisandagain commented

Good question! I think adding to the README should still be ok for now. If things get too long I think my inclination would be to move some of the detailed documentation into a Github wiki.

rishpandey commented

Ok. I'll use your comment on #107

rishpandey commented

Check it out, #124. Looks alright.