Skip to content
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

Improve documentation #112

Closed
3 tasks
thisandagain opened this issue Mar 28, 2017 · 4 comments
Closed
3 tasks

Improve documentation #112

thisandagain opened this issue Mar 28, 2017 · 4 comments

Comments

@thisandagain
Copy link
Owner

thisandagain commented Mar 28, 2017

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
Copy link
Contributor

Should this be added to README or use separate file?

@thisandagain
Copy link
Owner Author

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
Copy link
Contributor

Ok. I'll use your comment on #107

@rishpandey
Copy link
Contributor

Check it out, #124. Looks alright.

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

No branches or pull requests

2 participants